Pexip Engage API documentation

Update a subject

PATCH /subjects/{id}

OAuth2

Update a subject by its ID

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
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.

application/json

Body

externalId string | null

Minimum length is 1, maximum length is 255.
translations object
Hide translations attributes Show translations attributes
- name array[object]
  Hide name attributes Show name attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- description array[object]
  Hide description attributes Show description attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- instructions array[object]
  Hide instructions attributes Show instructions attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT 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.

Responses

• 200 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes
  
  id string Required
  
  Minimum length is 1.
  
  enabledForInternalUse boolean Required
  
  enabledForCustomerUse boolean Required
  
  order integer Required
  
  Minimum value is 0.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  name object | null Required
  
  Hide name attributes Show name attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  description object | null Required
  
  Hide description attributes Show description attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  instructions object | null Required
  
  Hide instructions attributes Show instructions attributes
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Additional properties are NOT allowed
  
  subjectGroup object Required
  
  Hide subjectGroup attributes Show subjectGroup attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  cancellationByAgentForm object | null
  
  Hide cancellationByAgentForm attributes Show cancellationByAgentForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  cancellationByCustomerForm object | null
  
  Hide cancellationByCustomerForm attributes Show cancellationByCustomerForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  completionByAgentForm object | null
  
  Hide completionByAgentForm attributes Show completionByAgentForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  questionnaireForm object | null
  
  Hide questionnaireForm attributes Show questionnaireForm attributes
  
  id string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  deletedAt string(date-time) | null Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  translations object Required
  
  Hide translations attributes Show translations attributes
  
  name array[object] Required
  
  At least 1 element.
  
  Hide name attributes Show name attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  description array[object]
  
  At least 0 elements.
  
  Hide description attributes Show description attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  instructions array[object]
  
  At least 0 elements.
  
  Hide instructions attributes Show instructions attributes object
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 404 application/json

Resource not found
Hide response attribute Show response attribute object
- errors array[object] Required
  
  At least 1 element.
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  Minimum length is 1.
  
  code string Required
  
  Minimum length is 1.
  
  type string Required
  
  Minimum length is 1.
  
  statusCode string Required
  
  Minimum length is 1.

PATCH /subjects/{id}

curl \
 -X PATCH https://api.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 example

# 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"
    }
  ]
}