POST Appointment
Body Required
-
entity Required
Value is
Appointment
. -
Additional properties are allowed.
Hide data attributes Show data attributes object
-
eventType Required
Values are
ACCEPT
,REASSIGN
,CANCEL
,COMPLETE
,CREATE
,RESCHEDULE
,REQUEST_ALTERNATIVE_DATE
,CREATE_REQUEST
,RESCHEDULE_REQUEST
,REOPEN
, orGENERIC_UPDATE
. appointment object Required
One of: Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attributes Show subject attributes object
-
Maximum length is
255
. -
Minimum value is
0
. -
Additional properties are NOT allowed.
Hide subjectGroup attributes Show subjectGroup attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide office attributes Show office attributes object
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
EMPLOYEE
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide employee attributes Show employee attributes object
-
Maximum length is
320
. -
Maximum length is
320
. -
Maximum length is
255
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
-
Values are
ADMIN
,AGENT
,CENTRAL_PLANNER
, orOFFICE_MANAGER
. -
status Required
Values are
ACTIVE
,SUSPENDED
, orPENDING
.
Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
CUSTOMER
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide customer attributes Show customer attributes object
-
Minimum value is
0
. -
Maximum length is
255
. -
Maximum length is
320
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
-
-
Hide answers attributes Show answers attributes object
-
Additional properties are NOT allowed.
Hide form attribute Show form attribute object
-
Additional properties are NOT allowed.
Hide question attributes Show question attributes object
-
externalId string | null
-
Additional properties are NOT allowed.
-
answerType Required
Values are
SUBJECT_QUESTIONNAIRE
,APPOINTMENT_CANCELLATION
,APPOINTMENT_COMPLETION
, orQUALIFICATION
. -
value string | null
-
selectedAnswerOptions array[object] | null
Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
-
externalId string | null
-
value string | null
-
files array[object] | null
Hide files attribute Show files attribute object
-
callbackRequest Required
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attributes Show listing attributes object | null
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide leadSegment attributes Show leadSegment attributes object | null
-
meetingType Required
Values are
OFFICE
,ON_LOCATION
,PHONE
, orVIDEO
. -
Maximum length is
255
. -
Additional properties are NOT allowed.
-
Additional properties are allowed.
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
createdFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
updatedByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
updatedFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
status Required
Values are
ACCEPTED
,COMPLETED
,NO_SHOW
, orCANCELLED
.
Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attributes Show subject attributes object
-
Maximum length is
255
. -
Minimum value is
0
. -
Additional properties are NOT allowed.
Hide subjectGroup attributes Show subjectGroup attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide office attributes Show office attributes object
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
EMPLOYEE
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide employee attributes Show employee attributes object
-
Maximum length is
320
. -
Maximum length is
320
. -
Maximum length is
255
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
-
Values are
ADMIN
,AGENT
,CENTRAL_PLANNER
, orOFFICE_MANAGER
. -
status Required
Values are
ACTIVE
,SUSPENDED
, orPENDING
.
Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
CUSTOMER
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide customer attributes Show customer attributes object
-
Minimum value is
0
. -
Maximum length is
255
. -
Maximum length is
320
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
-
-
Hide answers attributes Show answers attributes object
-
Additional properties are NOT allowed.
Hide form attribute Show form attribute object
-
Additional properties are NOT allowed.
Hide question attributes Show question attributes object
-
externalId string | null
-
Additional properties are NOT allowed.
-
answerType Required
Values are
SUBJECT_QUESTIONNAIRE
,APPOINTMENT_CANCELLATION
,APPOINTMENT_COMPLETION
, orQUALIFICATION
. -
value string | null
-
selectedAnswerOptions array[object] | null
Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
-
externalId string | null
-
value string | null
-
files array[object] | null
Hide files attribute Show files attribute object
-
callbackRequest Required
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attributes Show listing attributes object | null
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide leadSegment attributes Show leadSegment attributes object | null
-
meetingType Required
Values are
OFFICE
,ON_LOCATION
,PHONE
, orVIDEO
. -
Maximum length is
255
. -
Additional properties are NOT allowed.
-
Additional properties are allowed.
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
createdFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
updatedByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
updatedFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
status Required
Value is
INCOMING_REQUEST
.
Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attributes Show subject attributes object
-
Maximum length is
255
. -
Minimum value is
0
. -
Additional properties are NOT allowed.
Hide subjectGroup attributes Show subjectGroup attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide office attributes Show office attributes object
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
EMPLOYEE
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide employee attributes Show employee attributes object
-
Maximum length is
320
. -
Maximum length is
320
. -
Maximum length is
255
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
-
Values are
ADMIN
,AGENT
,CENTRAL_PLANNER
, orOFFICE_MANAGER
. -
status Required
Values are
ACTIVE
,SUSPENDED
, orPENDING
.
Hide attributes Show attributes
-
role Required
Values are
PRIMARY
orSECONDARY
. -
type Required
Value is
CUSTOMER
. -
Maximum length is
2000
. -
Maximum length is
2000
. -
Additional properties are NOT allowed.
Hide customer attributes Show customer attributes object
-
Minimum value is
0
. -
Maximum length is
255
. -
Maximum length is
320
. -
Maximum length is
2
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
-
-
Hide answers attributes Show answers attributes object
-
Additional properties are NOT allowed.
Hide form attribute Show form attribute object
-
Additional properties are NOT allowed.
Hide question attributes Show question attributes object
-
externalId string | null
-
Additional properties are NOT allowed.
-
answerType Required
Values are
SUBJECT_QUESTIONNAIRE
,APPOINTMENT_CANCELLATION
,APPOINTMENT_COMPLETION
, orQUALIFICATION
. -
value string | null
-
selectedAnswerOptions array[object] | null
Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object
-
externalId string | null
-
value string | null
-
files array[object] | null
Hide files attribute Show files attribute object
-
callbackRequest Required
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attributes Show listing attributes object | null
-
Maximum length is
255
. -
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide leadSegment attributes Show leadSegment attributes object | null
-
meetingType Required
Values are
OFFICE
,ON_LOCATION
,PHONE
, orVIDEO
. -
Maximum length is
255
. -
Additional properties are NOT allowed.
-
Additional properties are allowed.
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
createdFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
updatedByType Required
Values are
CUSTOMER
,EMPLOYEE
, orOTHER
. -
updatedFrom Required
Values are
PLUGIN
,BACKOFFICE_APP
,PARTNER_BOOKING_APP
, orOTHER
. -
status Required
Values are
OUTGOING_INVITE
orALTERNATIVE_DATE_REQUESTED
.
previousAppointment object | null Required
One of: Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attribute Show subject attribute object
-
Additional properties are NOT allowed.
Hide office attribute Show office attribute object
-
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attribute Show listing attribute object | null
-
Additional properties are NOT allowed.
Hide leadSegment attribute Show leadSegment attribute object | null
-
Maximum length is
255
. -
status Required
Values are
ACCEPTED
,COMPLETED
,NO_SHOW
, orCANCELLED
.
Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attribute Show subject attribute object
-
Additional properties are NOT allowed.
Hide office attribute Show office attribute object
-
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attribute Show listing attribute object | null
-
Additional properties are NOT allowed.
Hide leadSegment attribute Show leadSegment attribute object | null
-
Maximum length is
255
. -
status Required
Value is
INCOMING_REQUEST
.
Hide attributes Show attributes
-
Additional properties are NOT allowed.
Hide subject attribute Show subject attribute object
-
Additional properties are NOT allowed.
Hide office attribute Show office attribute object
-
-
Additional properties are NOT allowed.
Hide location attributes Show location attributes object | null
-
Minimum length is
2
, maximum length is2
. -
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide translations attributes Show translations attributes object
-
Additional properties are NOT allowed.
Hide listing attribute Show listing attribute object | null
-
Additional properties are NOT allowed.
Hide leadSegment attribute Show leadSegment attribute object | null
-
Maximum length is
255
. -
status Required
Values are
OUTGOING_INVITE
orALTERNATIVE_DATE_REQUESTED
.
-
-
{
"id": "string",
"correlationId": "string",
"webhookConfigurationId": "string",
"version": "string",
"entity": "Appointment",
"data": {
"eventType": "ACCEPT",
"message": "string",
"appointment": {
"id": "string",
"subject": {
"id": "string",
"externalId": "string",
"enabledForCustomerUse": true,
"enabledForInternalUse": true,
"order": 42,
"cancellationByAgentFormId": "string",
"cancellationByCustomerFormId": "string",
"completionByAgentFormId": "string",
"questionnaireFormId": "string",
"subjectGroup": {
"id": "string",
"externalId": "string",
"order": 42,
"color": "string",
"image": "string",
"translations": {
"name": [
{
"value": "string",
"language": "string"
}
]
},
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
},
"translations": {
"name": [
{
"value": "string",
"language": "string"
}
],
"description": [
{
"value": "string",
"language": "string"
}
],
"instructions": [
{
"value": "string",
"language": "string"
}
]
},
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
},
"office": {
"id": "string",
"active": true,
"email": "string",
"externalId": "string",
"phoneNumber": "string",
"timeZone": "string",
"usesIndependentAgents": true,
"virtual": true,
"location": {
"postalCode": "string",
"countryCode": "string",
"geolocation": {
"latitude": 42.0,
"longitude": 42.0
},
"translations": {
"city": [
{
"value": "string",
"language": "string"
}
],
"street1": [
{
"value": "string",
"language": "string"
}
],
"street2": [
{
"value": "string",
"language": "string"
}
],
"state": [
{
"value": "string",
"language": "string"
}
]
}
},
"translations": {
"name": [
{
"value": "string",
"language": "string"
}
],
"description": [
{
"value": "string",
"language": "string"
}
],
"directions": [
{
"value": "string",
"language": "string"
}
],
"parkingInfo": [
{
"value": "string",
"language": "string"
}
]
},
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
},
"participants": [
{
"role": "PRIMARY",
"type": "EMPLOYEE",
"token": "string",
"videoUrl": "string",
"videoTestUrl": "string",
"cancelUrl": "string",
"editUrl": "string",
"inviteUrl": "string",
"office365CalendarUrl": "string",
"googleCalendarUrl": "string",
"icalUrl": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"employee": {
"id": "string",
"communicationEmail": "string",
"email": "string",
"externalId": "string",
"firstName": "string",
"language": "string",
"lastName": "string",
"onlinePlanning": true,
"phoneNumber": "string",
"profilePictureUrl": "string",
"staticVideoUrl": "string",
"translations": {
"function": [
{
"value": "string",
"language": "string"
}
]
},
"availableRoles": [
"ADMIN"
],
"status": "ACTIVE",
"timeZone": "string",
"userId": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
}
}
],
"answers": [
{
"id": "string",
"form": {
"id": "string"
},
"question": {
"id": "string",
"externalId": "string",
"order": 42,
"translations": {
"label": [
{
"value": "string",
"language": "string"
}
]
}
},
"answerType": "SUBJECT_QUESTIONNAIRE",
"value": "string",
"selectedAnswerOptions": [
{
"id": "string",
"externalId": "string",
"value": "string"
}
],
"files": [
{
"id": "string"
}
],
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
}
],
"location": {
"postalCode": "string",
"countryCode": "string",
"geolocation": {
"latitude": 42.0,
"longitude": 42.0
},
"translations": {
"city": [
{
"value": "string",
"language": "string"
}
],
"street1": [
{
"value": "string",
"language": "string"
}
],
"street2": [
{
"value": "string",
"language": "string"
}
],
"state": [
{
"value": "string",
"language": "string"
}
]
}
},
"listing": {
"id": "string",
"active": true,
"externalId": "string",
"timeZone": "string",
"location": {
"postalCode": "string",
"countryCode": "string",
"geolocation": {
"latitude": 42.0,
"longitude": 42.0
},
"translations": {
"city": [
{
"value": "string",
"language": "string"
}
],
"street1": [
{
"value": "string",
"language": "string"
}
],
"street2": [
{
"value": "string",
"language": "string"
}
],
"state": [
{
"value": "string",
"language": "string"
}
]
}
},
"tags": [
"string"
],
"translations": {
"name": [
{
"value": "string",
"language": "string"
}
],
"description": [
{
"value": "string",
"language": "string"
}
]
},
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00"
},
"leadSegment": {
"id": 42,
"active": true,
"code": "string",
"description": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00",
"deletedAt": "string"
},
"meetingType": "OFFICE",
"externalId": "string",
"hybrid": true,
"trailingBufferTime": 42,
"internalNotes": "string",
"meetingRoom": {
"id": "string",
"email": "string",
"externalId": "string",
"name": "string",
"provider": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"updatedAt": "2024-05-04T09:42:00+00:00",
"deletedAt": "string"
},
"messageForCustomer": "string",
"metadata": {},
"createdAt": "2024-05-04T09:42:00+00:00",
"createdById": "string",
"createdByType": "CUSTOMER",
"createdFrom": "PLUGIN",
"updatedAt": "2024-05-04T09:42:00+00:00",
"updatedById": "string",
"updatedByType": "CUSTOMER",
"updatedFrom": "PLUGIN",
"status": "ACCEPTED",
"start": "2024-05-04T09:42:00+00:00",
"end": "2024-05-04T09:42:00+00:00"
},
"previousAppointment": {
"subject": {
"id": "string"
},
"office": {
"id": "string"
},
"participants": [
{
"role": "PRIMARY",
"token": "string",
"videoUrl": "string",
"videoTestUrl": "string",
"employee": {
"id": "string"
},
"type": "EMPLOYEE"
}
],
"location": {
"postalCode": "string",
"countryCode": "string",
"geolocation": {
"latitude": 42.0,
"longitude": 42.0
},
"translations": {
"city": [
{
"value": "string",
"language": "string"
}
],
"street1": [
{
"value": "string",
"language": "string"
}
],
"street2": [
{
"value": "string",
"language": "string"
}
],
"state": [
{
"value": "string",
"language": "string"
}
]
}
},
"listing": {
"id": "string"
},
"leadSegment": {
"id": "string"
},
"externalId": "string",
"status": "ACCEPTED",
"start": "2024-05-04T09:42:00+00:00",
"end": "2024-05-04T09:42:00+00:00"
}
}
}