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
-
Primary identifier of the requested resource
Minimum length is
1
.
Body
-
externalId string | null
Minimum length is
1
, maximum length is255
. -
translations object
Additional properties are allowed.
-
order integer | null
Minimum value is
0
. -
subjectGroupId string | null
Minimum length is
1
. -
enabledForInternalUse boolean | null
-
enabledForCustomerUse boolean | null
-
cancellationByAgentFormId string | null
Minimum length is
1
. -
cancellationByCustomerFormId string | null
Minimum length is
1
. -
completionByAgentFormId string | null
Minimum length is
1
. -
questionnaireFormId string | null
Minimum length is
1
.
PATCH
/subjects/{id}
curl \
-X PATCH https://api.development.pexipengage.com/enterprises/acme/subjects/1234 \
-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 '{"externalId":"ABCD1234","translations":{"name":[{"language":"en","value":"Lorem ipsum"}],"description":[{"language":"en","value":"Lorem ipsum"}],"instructions":[{"language":"en","value":"Lorem ipsum"}]},"order":5,"subjectGroupId":"123","enabledForInternalUse":true,"enabledForCustomerUse":true,"cancellationByAgentFormId":"123","cancellationByCustomerFormId":"123","completionByAgentFormId":"123","questionnaireFormId":"123"}'
Request examples
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *
# Payload
{
"externalId": "ABCD1234",
"translations": {
"name": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"description": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"instructions": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
},
"order": 5,
"subjectGroupId": "123",
"enabledForInternalUse": true,
"enabledForCustomerUse": true,
"cancellationByAgentFormId": "123",
"cancellationByCustomerFormId": "123",
"completionByAgentFormId": "123",
"questionnaireFormId": "123"
}
Response examples (200)
{
"data": {
"id": "123",
"enabledForInternalUse": true,
"enabledForCustomerUse": true,
"order": 5,
"externalId": "ABCD1234",
"name": {
"language": "en",
"value": "Lorem ipsum"
},
"description": {
"language": "en",
"value": "Lorem ipsum"
},
"instructions": {
"language": "en",
"value": "Lorem ipsum"
},
"subjectGroup": {
"id": "123"
},
"cancellationByAgentForm": {
"id": "123"
},
"cancellationByCustomerForm": {
"id": "123"
},
"completionByAgentForm": {
"id": "123"
},
"questionnaireForm": {
"id": "123"
},
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"translations": {
"name": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"description": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"instructions": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (404)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}