HandleAppointmentInput

actionstringrequired

Possible values: [confirm, request_alternatives, cancel, takeover, update]

versionintegerrequired

Possible values: >= 1

payload objectrequired

confirm accepts serviceId, reason, startIso, durationMinutes, location, and message; request_alternatives and takeover accept message; cancel accepts message and takeoverConversation. update accepts serviceId, reason, startIso, durationMinutes, location, attendeeName, attendeeEmail and answers. Public/API bookings have no conversation: takeover returns APPOINTMENT_CONVERSATION_NOT_APPLICABLE.

serviceIdstring

Possible values: <= 100 characters

reasonstring

Possible values: <= 2000 characters

startIsostring<date-time>

durationMinutesinteger

Possible values: >= 1 and <= 1440

locationstring

Possible values: <= 500 characters

messagestring

Possible values: non-empty and <= 2000 characters

takeoverConversationboolean

attendeeNamestring

Possible values: non-empty and <= 200 characters

attendeeEmailstring<email>

Possible values: <= 320 characters

answers object[]

Possible values: <= 100

Array [

questionIdstringrequired

Possible values: non-empty and <= 100 characters

value objectrequired

oneOf

• string
• string[]

string

Possible values: non-empty and <= 2000 characters

]

HandleAppointmentInput

{
  "action": "confirm",
  "version": 0,
  "payload": {
    "serviceId": "string",
    "reason": "string",
    "startIso": "2024-07-29T15:51:28.071Z",
    "durationMinutes": 0,
    "location": "string",
    "message": "string",
    "takeoverConversation": true,
    "attendeeName": "string",
    "attendeeEmail": "[email protected]",
    "answers": [
      {
        "questionId": "string",
        "value": "string"
      }
    ]
  }
}