Headers
-
X-Correlation-Id string
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language string
Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Body Required
-
Minimum length is
1
. -
Minimum length is
1
. -
At least
2
elements. -
callbackRequestId string | null
Minimum length is
1
. -
location object | null
Additional properties are NOT allowed.
-
listingId string | null
Minimum length is
1
. -
leadSegmentId string | null
Minimum length is
1
. -
meetingRoomId string | null
Minimum length is
1
. -
Values are
OFFICE
,ON_LOCATION
,PHONE
, orVIDEO
. -
externalId string | null
Minimum length is
1
, maximum length is255
. -
hybrid boolean | null
-
trailingBufferTime integer | null
Minimum value is
0
. Default value is0
. -
internalNotes string | null
Minimum length is
1
. -
message string | null
Deprecated. Make use of the messageForCustomer field
Minimum length is
1
. -
messageForCustomer string | null
Minimum length is
1
.
Responses
-
201 application/json
Successful operation
-
422 application/json
Business validation failed
APPOINTMENT_LOCATION_REQUIRED
APPOINTMENT_PARTICIPANTS_NOT_UNIQUE
LOCATION_GEOCODING_FAILED
LOCATION_TIME_ZONE_RESOLUTION_FAILED
See Error codes
POST
/appointments/_actions/invite
curl \
-X POST https://api.development.pexipengage.com/enterprises/acme/appointments/_actions/invite \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *" \
-d '{"subjectId":"123","officeId":"123","appointmentParticipants":[{"role":"PRIMARY","participantId":"123","type":"EMPLOYEE"}],"callbackRequestId":"123","location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"language":"en","value":"Lorem ipsum"}]}},"listingId":"123","leadSegmentId":"123","meetingRoomId":"123","meetingType":"OFFICE","externalId":"ABCD1234","hybrid":true,"trailingBufferTime":5,"internalNotes":"Lorem ipsum","message":"Let's chat!","messageForCustomer":"Let's chat!"}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *
# Payload
{
"subjectId": "123",
"officeId": "123",
"appointmentParticipants": [
{
"role": "PRIMARY",
"participantId": "123",
"type": "EMPLOYEE"
}
],
"callbackRequestId": "123",
"location": {
"postalCode": "9000",
"countryCode": "BE",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
},
"listingId": "123",
"leadSegmentId": "123",
"meetingRoomId": "123",
"meetingType": "OFFICE",
"externalId": "ABCD1234",
"hybrid": true,
"trailingBufferTime": 5,
"internalNotes": "Lorem ipsum",
"message": "Let's chat!",
"messageForCustomer": "Let's chat!"
}
Response examples (201)
{
"data": {
"id": "123",
"externalId": "ABCD1234",
"start": "2022-08-17T09:00:00.000Z",
"end": "2022-08-17T10:00:00.000Z",
"subject": {
"id": "123"
},
"office": {
"id": "123"
},
"appointmentParticipants": [
{
"role": "PRIMARY",
"participant": {
"id": "string"
},
"type": "EMPLOYEE",
"videoUrl": "https://wwww.example.net/abc123",
"videoTestUrl": "https://wwww.example.net/abc123"
}
],
"answers": [
{
"value": "A colleague",
"selectedAnswerOptions": [
{
"id": "123"
}
],
"files": [
{
"id": "123"
}
],
"id": "123",
"form": {
"id": "123"
},
"question": {
"id": "123"
},
"answerType": "SUBJECT_QUESTIONNAIRE",
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z"
}
],
"callbackRequest": {
"id": "123"
},
"listing": {
"id": "123"
},
"leadSegment": {
"id": "123"
},
"meetingRoom": {
"id": "123"
},
"meetingType": "OFFICE",
"status": "ACCEPTED",
"hybrid": true,
"trailingBufferTime": 5,
"internalNotes": "Lorem ipsum",
"messageForCustomer": "Lorem ipsum",
"createdAt": "2022-08-17T19:05:21.362Z",
"createdBy": {
"id": "123"
},
"createdByType": "EMPLOYEE",
"createdFrom": "BACKOFFICE_APP",
"updatedAt": "2022-08-17T19:05:21.362Z",
"updatedBy": {
"id": "123"
},
"updatedByType": "EMPLOYEE",
"updatedFrom": "BACKOFFICE_APP",
"location": {
"city": {
"language": "en",
"value": "Lorem ipsum"
},
"state": {
"language": "en",
"value": "Lorem ipsum"
},
"street1": {
"language": "en",
"value": "Lorem ipsum"
},
"street2": {
"language": "en",
"value": "Lorem ipsum"
},
"postalCode": "9000",
"countryCode": "BE",
"formattedAddress": "string",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
}
Response examples (422)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string",
"arguments": {}
}
]
}