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.
Path parameters
-
id string Required
Primary identifier of the requested resource
Minimum length is
1.
POST /appointments/{id}/_actions/accept
curl \
-X POST https://api.pexipengage.com/enterprises/acme/appointments/1234/_actions/accept \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *"
Response examples (200)
{
"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"
}
],
"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"
},
"meetingType": "OFFICE",
"status": "ACCEPTED",
"hybrid": true,
"trailingBufferTime": 5,
"internalNotes": "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 (404)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}
Response examples (422)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string",
"arguments": {}
}
]
}