Client requests

Conversations attached to a booking. Ask for an amendment or a cancellation, raise a question or a complaint, reply, and reopen or close the thread. New requests and replies trigger a CLIENT_REQUEST webhook.

A client request is a conversation thread attached to a booking. Four endpoints create a request, reply to it, reopen it and close it. Each returns the request as a ClientRequestVO. Spec

A message, not a change to the bookingDocs

Creating or replying to a client request does not change booking data. A CANCELLATION request asks for a cancellation; it cancels nothing. To cancel the hotel yourself, use Cancel.

Create a request

POST/booking/{bookingReference}/client-requests

Headers

auth-tokenstringrequired

Any valid token.

Accept-EncodingstringrequiredDocs

gzip

Content-Typestringrequired

application/json

Path

bookingReferencestringrequired

Trip reference, for example TST-1464.

Body

typestringrequiredSpec

AMENDMENT, CANCELLATION, QUESTION, COMPLAINT or OTHER.

message[]object[]Unverified

Items shaped { message, user, date }. Send your text in message; user and date are probably filled in by the platform.

200 OK

ClientRequestVOobject

The new request. Keep its id for the calls below.

Request

curl -s --compressed -X POST \
  "$NAVA_BASE_URL/booking/TST-1464/client-requests" \
  -H "auth-token: $TOKEN" \
  -H "Accept-Encoding: gzip" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "AMENDMENT",
    "message": [{ "message": "Please correct the second guest name to Omar Haddad." }]
  }'

Response 200 (illustrative)

{
  "id": "…",
  "creationDate": "…",
  "type": "AMENDMENT",
  "requestClosed": false,
  "message": [
    {
      "message": "Please correct the second guest name to Omar Haddad.",
      "user": "…",
      "date": "…"
    }
  ]
}

Reply to a request

POST/booking/{bookingReference}/client-requests/{clientRequestId}/reply

Headers

auth-tokenstringrequired

Any valid token.

Accept-EncodingstringrequiredDocs

gzip

Content-Typestringrequired

application/json

Path

bookingReferencestringrequired

Trip reference.

clientRequestIdstringrequired

The request's id.

Body

messagestringUnverified

The reply text. The spec shows the body as { message }; we assume a plain string.

200 OK

ClientRequestVOobject

The updated request.

Request

curl -s --compressed -X POST \
  "$NAVA_BASE_URL/booking/TST-1464/client-requests/$REQUEST_ID/reply" \
  -H "auth-token: $TOKEN" \
  -H "Accept-Encoding: gzip" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Thank you, the guest confirms the new spelling." }'

Reopen a request

PUT/booking/{bookingReference}/client-requests/{clientRequestId}/open

Headers

auth-tokenstringrequired

Any valid token.

Accept-EncodingstringrequiredDocs

gzip

Path

bookingReferencestringrequired

Trip reference.

clientRequestIdstringrequired

The request's id.

No request body.

200 OK

ClientRequestVOobject

The reopened request.

Close a request

PUT/booking/{bookingReference}/client-requests/{clientRequestId}/close

Headers

auth-tokenstringrequired

Any valid token.

Accept-EncodingstringrequiredDocs

gzip

Path

bookingReferencestringrequired

Trip reference.

clientRequestIdstringrequired

The request's id.

No request body.

200 OK

ClientRequestVOobject

The closed request. requestClosed and closingDate probably reflect the change. Unverified

Request

curl -s --compressed -X PUT \
  "$NAVA_BASE_URL/booking/TST-1464/client-requests/$REQUEST_ID/close" \
  -H "auth-token: $TOKEN" \
  -H "Accept-Encoding: gzip"

Response 200 (illustrative)

{
  "id": "…",
  "creationDate": "…",
  "closingDate": "…",
  "type": "AMENDMENT",
  "requestClosed": true,
  "message": [
    { "message": "Please correct the second guest name to Omar Haddad.", "user": "…", "date": "…" },
    { "message": "Thank you, the guest confirms the new spelling.", "user": "…", "date": "…" }
  ]
}

ClientRequestVO

Every endpoint on this page returns this object. The same objects appear in the trip's clientrequest[] from Get booking. Spec

ClientRequestVO

id

The request id. Use it as clientRequestId.

typestringrequiredSpec

AMENDMENT, CANCELLATION, QUESTION, COMPLAINT or OTHER.

creationDate

When the request was created.

closingDate

When the request was closed.

requestClosedboolean

Whether the request is closed.

message[]object[]

The thread, one entry per message.

Child attributes

messagestring

The text.

user

Who wrote it.

date

When it was written.

Webhooks and getBookings

Creating a request or replying to one fires a CLIENT_REQUEST webhook. Docs It is not documented whether reopening or closing does.
The webhook body carries no message text, so fetch the trip with Get booking and read clientrequest[] to see the new message.
Answer every webhook type with a 2xx, CLIENT_REQUEST included. A receiver that accepted only CREATED, MODIFIED and CANCELED returned 400 on CLIENT_REQUEST, which caused retries, an alert email and a lost event. Verified

Errors

The spec documents no error schema and no status codes. Treat any non-2xx response as a failure and keep the raw body, the trace id (auditData.traceId or the Travelc-Trace-Id header) and the x-request-id header. Spec A 404 on the booking means the reference doesn't exist (in this microsite). Verified

Get booking: clientrequest[] on the trip
Webhooks: the CLIENT_REQUEST event
Cancel: cancel the hotel yourself

Create a requestCopy Anchor Link

Reply to a requestCopy Anchor Link

Reopen a requestCopy Anchor Link

Close a requestCopy Anchor Link

ClientRequestVOCopy Anchor Link

Webhooks and getBookingsCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

Create a request

Reply to a request

Reopen a request

Close a request

ClientRequestVO

Webhooks and getBookings

Errors

Related