POST Appointment
POST
/Appointment
Body Required
-
id string Required
-
correlationId string Required
-
webhookConfigurationId string Required
-
version string Required
-
entity Required
Value is
Appointment. -
data object Required
Hide data attributes Show data attributes
-
eventType Required
Values are
ACCEPT,REASSIGN,CANCEL,COMPLETE,CREATE,RESCHEDULE,REQUEST_ALTERNATIVE_DATE,CREATE_REQUEST,RESCHEDULE_REQUEST,REOPEN, orGENERIC_UPDATE. -
message string | null Required
- appointment object Required
One of: Hide attributes Show attributes
-
id string Required
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
enabledForCustomerUse boolean Required
-
enabledForInternalUse boolean Required
-
order integer Required
Minimum value is
0. -
cancellationByAgentFormId string | null Required
-
cancellationByCustomerFormId string | null Required
-
completionByAgentFormId string | null Required
-
questionnaireFormId string | null Required
-
subjectGroup object Required
Hide subjectGroup attributes Show subjectGroup attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
order integer Required
Minimum value is
0. -
color string | null
Maximum length is
7. -
image string | null
Maximum length is
65535. -
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
instructions array[object] Required
Hide instructions attributes Show instructions attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
active boolean Required
-
email string | null Required
-
externalId string | null Required
Maximum length is
255. -
phoneNumber string | null Required
-
timeZone string Required
-
usesIndependentAgents boolean Required
-
virtual boolean Required
-
location object Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
directions array[object] Required
Hide directions attributes Show directions attributes object
-
parkingInfo array[object] Required
Hide parkingInfo attributes Show parkingInfo attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
EMPLOYEE. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
communicationEmail string | null Required
Maximum length is
320. -
email string Required
Maximum length is
320. -
externalId string | null Required
Maximum length is
255. -
firstName string | null Required
-
language string Required
Maximum length is
2. -
lastName string | null Required
-
onlinePlanning boolean Required
-
phoneNumber string | null Required
-
profilePictureUrl string | null Required
-
staticVideoUrl string | null Required
-
translations object Required
Hide translations attributes Show translations attributes
-
availableRoles array[string] Required
Values are
ADMIN,AGENT,CENTRAL_PLANNER, orOFFICE_MANAGER. -
status Required
Values are
ACTIVE,SUSPENDED, orPENDING. -
timeZone string Required
-
userId string | null Required
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
CUSTOMER. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
customer object Required
Hide customer attributes Show customer attributes
-
id integer Required
Minimum value is
0. -
externalId string | null Required
Maximum length is
255. -
customerNumber string | null Required
-
email string | null Required
Maximum length is
320. -
firstName string | null Required
-
lastName string | null Required
-
existing boolean Required
-
company string | null Required
-
language string Required
Maximum length is
2. -
notes string | null Required
-
phoneNumber string | null Required
-
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
deletedAt string | null Required
-
-
-
answers array[object] Required
Hide answers attributes Show answers attributes object
-
id string Required
-
form object Required
Hide form attributes Show form attributes
-
id string Required
-
-
question object Required
Hide question attributes Show question attributes
-
id string Required
-
externalId string | null
-
order integer Required
-
translations object Required
Hide translations attributes Show translations attributes
-
-
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
-
id string Required
-
externalId string | null
-
value string | null
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
callbackRequest Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
active boolean Required
-
externalId string | null Required
Maximum length is
255. -
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
tags array[string] Required
-
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
meetingType Required
Values are
OFFICE,ON_LOCATION,PHONE, orVIDEO. -
externalId string | null Required
Maximum length is
255. -
hybrid boolean Required
-
trailingBufferTime integer Required
-
internalNotes string | null Required
-
metadata object | null Required
-
createdAt string(date-time) Required
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER,EMPLOYEE, orOTHER. -
createdFrom Required
Values are
PLUGIN,BACKOFFICE_APP,PARTNER_BOOKING_APP, orOTHER. -
updatedAt string(date-time) Required
-
updatedById string | null Required
-
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. -
start string(date-time) Required
-
end string(date-time) Required
Hide attributes Show attributes
-
id string Required
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
enabledForCustomerUse boolean Required
-
enabledForInternalUse boolean Required
-
order integer Required
Minimum value is
0. -
cancellationByAgentFormId string | null Required
-
cancellationByCustomerFormId string | null Required
-
completionByAgentFormId string | null Required
-
questionnaireFormId string | null Required
-
subjectGroup object Required
Hide subjectGroup attributes Show subjectGroup attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
order integer Required
Minimum value is
0. -
color string | null
Maximum length is
7. -
image string | null
Maximum length is
65535. -
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
instructions array[object] Required
Hide instructions attributes Show instructions attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
active boolean Required
-
email string | null Required
-
externalId string | null Required
Maximum length is
255. -
phoneNumber string | null Required
-
timeZone string Required
-
usesIndependentAgents boolean Required
-
virtual boolean Required
-
location object Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
directions array[object] Required
Hide directions attributes Show directions attributes object
-
parkingInfo array[object] Required
Hide parkingInfo attributes Show parkingInfo attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
EMPLOYEE. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
communicationEmail string | null Required
Maximum length is
320. -
email string Required
Maximum length is
320. -
externalId string | null Required
Maximum length is
255. -
firstName string | null Required
-
language string Required
Maximum length is
2. -
lastName string | null Required
-
onlinePlanning boolean Required
-
phoneNumber string | null Required
-
profilePictureUrl string | null Required
-
staticVideoUrl string | null Required
-
translations object Required
Hide translations attributes Show translations attributes
-
availableRoles array[string] Required
Values are
ADMIN,AGENT,CENTRAL_PLANNER, orOFFICE_MANAGER. -
status Required
Values are
ACTIVE,SUSPENDED, orPENDING. -
timeZone string Required
-
userId string | null Required
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
CUSTOMER. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
customer object Required
Hide customer attributes Show customer attributes
-
id integer Required
Minimum value is
0. -
externalId string | null Required
Maximum length is
255. -
customerNumber string | null Required
-
email string | null Required
Maximum length is
320. -
firstName string | null Required
-
lastName string | null Required
-
existing boolean Required
-
company string | null Required
-
language string Required
Maximum length is
2. -
notes string | null Required
-
phoneNumber string | null Required
-
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
deletedAt string | null Required
-
-
-
answers array[object] Required
Hide answers attributes Show answers attributes object
-
id string Required
-
form object Required
Hide form attributes Show form attributes
-
id string Required
-
-
question object Required
Hide question attributes Show question attributes
-
id string Required
-
externalId string | null
-
order integer Required
-
translations object Required
Hide translations attributes Show translations attributes
-
-
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
-
id string Required
-
externalId string | null
-
value string | null
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
callbackRequest Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
active boolean Required
-
externalId string | null Required
Maximum length is
255. -
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
tags array[string] Required
-
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
meetingType Required
Values are
OFFICE,ON_LOCATION,PHONE, orVIDEO. -
externalId string | null Required
Maximum length is
255. -
hybrid boolean Required
-
trailingBufferTime integer Required
-
internalNotes string | null Required
-
metadata object | null Required
-
createdAt string(date-time) Required
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER,EMPLOYEE, orOTHER. -
createdFrom Required
Values are
PLUGIN,BACKOFFICE_APP,PARTNER_BOOKING_APP, orOTHER. -
updatedAt string(date-time) Required
-
updatedById string | null Required
-
updatedByType Required
Values are
CUSTOMER,EMPLOYEE, orOTHER. -
updatedFrom Required
Values are
PLUGIN,BACKOFFICE_APP,PARTNER_BOOKING_APP, orOTHER. -
status Required
Value is
INCOMING_REQUEST. -
start string(date-time) Required
-
end string(date-time) Required
Hide attributes Show attributes
-
id string Required
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
enabledForCustomerUse boolean Required
-
enabledForInternalUse boolean Required
-
order integer Required
Minimum value is
0. -
cancellationByAgentFormId string | null Required
-
cancellationByCustomerFormId string | null Required
-
completionByAgentFormId string | null Required
-
questionnaireFormId string | null Required
-
subjectGroup object Required
Hide subjectGroup attributes Show subjectGroup attributes
-
id string Required
-
externalId string | null Required
Maximum length is
255. -
order integer Required
Minimum value is
0. -
color string | null
Maximum length is
7. -
image string | null
Maximum length is
65535. -
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
instructions array[object] Required
Hide instructions attributes Show instructions attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
active boolean Required
-
email string | null Required
-
externalId string | null Required
Maximum length is
255. -
phoneNumber string | null Required
-
timeZone string Required
-
usesIndependentAgents boolean Required
-
virtual boolean Required
-
location object Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
translations object Required
Hide translations attributes Show translations attributes
-
name array[object] Required
Hide name attributes Show name attributes object
-
description array[object] Required
Hide description attributes Show description attributes object
-
directions array[object] Required
Hide directions attributes Show directions attributes object
-
parkingInfo array[object] Required
Hide parkingInfo attributes Show parkingInfo attributes object
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
EMPLOYEE. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
communicationEmail string | null Required
Maximum length is
320. -
email string Required
Maximum length is
320. -
externalId string | null Required
Maximum length is
255. -
firstName string | null Required
-
language string Required
Maximum length is
2. -
lastName string | null Required
-
onlinePlanning boolean Required
-
phoneNumber string | null Required
-
profilePictureUrl string | null Required
-
staticVideoUrl string | null Required
-
translations object Required
Hide translations attributes Show translations attributes
-
availableRoles array[string] Required
Values are
ADMIN,AGENT,CENTRAL_PLANNER, orOFFICE_MANAGER. -
status Required
Values are
ACTIVE,SUSPENDED, orPENDING. -
timeZone string Required
-
userId string | null Required
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
type Required
Value is
CUSTOMER. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
cancelUrl string Required
-
editUrl string Required
-
inviteUrl string Required
-
office365CalendarUrl string Required
-
googleCalendarUrl string Required
-
icalUrl string Required
-
createdAt string(date-time) Required
-
customer object Required
Hide customer attributes Show customer attributes
-
id integer Required
Minimum value is
0. -
externalId string | null Required
Maximum length is
255. -
customerNumber string | null Required
-
email string | null Required
Maximum length is
320. -
firstName string | null Required
-
lastName string | null Required
-
existing boolean Required
-
company string | null Required
-
language string Required
Maximum length is
2. -
notes string | null Required
-
phoneNumber string | null Required
-
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
deletedAt string | null Required
-
-
-
answers array[object] Required
Hide answers attributes Show answers attributes object
-
id string Required
-
form object Required
Hide form attributes Show form attributes
-
id string Required
-
-
question object Required
Hide question attributes Show question attributes
-
id string Required
-
externalId string | null
-
order integer Required
-
translations object Required
Hide translations attributes Show translations attributes
-
-
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
-
id string Required
-
externalId string | null
-
value string | null
-
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
callbackRequest Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
active boolean Required
-
externalId string | null Required
Maximum length is
255. -
timeZone string Required
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
tags array[string] Required
-
translations object Required
Hide translations attributes Show translations attributes
-
createdAt string(date-time) Required
-
updatedAt string(date-time) Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
meetingType Required
Values are
OFFICE,ON_LOCATION,PHONE, orVIDEO. -
externalId string | null Required
Maximum length is
255. -
hybrid boolean Required
-
trailingBufferTime integer Required
-
internalNotes string | null Required
-
metadata object | null Required
-
createdAt string(date-time) Required
-
createdById string | null
-
createdByType Required
Values are
CUSTOMER,EMPLOYEE, orOTHER. -
createdFrom Required
Values are
PLUGIN,BACKOFFICE_APP,PARTNER_BOOKING_APP, orOTHER. -
updatedAt string(date-time) Required
-
updatedById string | null Required
-
updatedByType Required
Values are
CUSTOMER,EMPLOYEE, orOTHER. -
updatedFrom Required
Values are
PLUGIN,BACKOFFICE_APP,PARTNER_BOOKING_APP, orOTHER. -
status Required
Values are
OUTGOING_INVITEorALTERNATIVE_DATE_REQUESTED. -
start null Required
-
end null Required
-
- previousAppointment object | null Required
One of: Hide attributes Show attributes
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
-
type Required
Value is
EMPLOYEE.
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
customer object Required
Hide customer attributes Show customer attributes
-
id string Required
-
-
type Required
Value is
CUSTOMER.
-
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
id string Required
-
-
externalId string | null Required
Maximum length is
255. -
status Required
Values are
ACCEPTED,COMPLETED,NO_SHOW, orCANCELLED. -
start string(date-time) Required
-
end string(date-time) Required
Hide attributes Show attributes
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
-
type Required
Value is
EMPLOYEE.
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
customer object Required
Hide customer attributes Show customer attributes
-
id string Required
-
-
type Required
Value is
CUSTOMER.
-
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
id string Required
-
-
externalId string | null Required
Maximum length is
255. -
status Required
Value is
INCOMING_REQUEST. -
start string(date-time) Required
-
end string(date-time) Required
Hide attributes Show attributes
-
subject object Required
Hide subject attributes Show subject attributes
-
id string Required
-
-
office object Required
Hide office attributes Show office attributes
-
id string Required
-
-
participants array[object] Required
One of: Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
employee object Required
Hide employee attributes Show employee attributes
-
id string Required
-
-
type Required
Value is
EMPLOYEE.
Hide attributes Show attributes
-
role Required
Values are
PRIMARYorSECONDARY. -
token string Required
-
videoUrl string | null Required
Maximum length is
2000. -
videoTestUrl string | null Required
Maximum length is
2000. -
customer object Required
Hide customer attributes Show customer attributes
-
id string Required
-
-
type Required
Value is
CUSTOMER.
-
-
location object | null Required
Hide location attributes Show location attributes
-
postalCode string | null Required
-
countryCode string Required
Minimum length is
2, maximum length is2. -
geolocation object Required
Hide geolocation attributes Show geolocation attributes
-
translations object Required
Hide translations attributes Show translations attributes
-
city array[object] Required
Hide city attributes Show city attributes object
-
street1 array[object] Required
Hide street1 attributes Show street1 attributes object
-
street2 array[object] Required
Hide street2 attributes Show street2 attributes object
-
state array[object] Required
Hide state attributes Show state attributes object
-
-
-
listing object | null Required
Hide listing attributes Show listing attributes
-
id string Required
-
-
leadSegment object | null Required
Hide leadSegment attributes Show leadSegment attributes
-
id string Required
-
-
externalId string | null Required
Maximum length is
255. -
status Required
Values are
OUTGOING_INVITEorALTERNATIVE_DATE_REQUESTED. -
start null Required
-
end null Required
-
-
POST Appointment
Request example
{
"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"
}
],
"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",
"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"
}
}
}