Update a subject group

PATCH /subject-groups/{id}

OAuth2

Update a subject group 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.
image string(uri) | null

Minimum length is 1.
translations object

Additional properties are allowed.
Hide translations attribute Show translations attribute object
- 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.
color string | null

Minimum length is 7, maximum length is 7.
order integer | null

Minimum value is 0.

Responses

200 application/json

Successful operation
Hide response attribute Show response attribute object
- data object Required
  
  Additional properties are NOT allowed.
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  color string Required
  
  Minimum length is 7, maximum length is 7.
  
  order integer Required
  
  Minimum value is 0.
  
  externalId string | null
  
  Minimum length is 1, maximum length is 255.
  
  image string(uri) | null
  
  Minimum length is 1.
  
  name object | null Required
  
  Additional properties are NOT allowed.
  
  Hide name attributes Show name attributes object | null
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  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.
  
  translations object Required
  
  Additional properties are NOT allowed.
  
  Hide translations attribute Show translations attribute object
  
  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.
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.
422 application/json

Business validation failed

See Error codes
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.
  
  arguments object | null
  
  Additional properties are allowed.

PATCH /subject-groups/{id}

curl \
 -X PATCH https://api.development.pexipengage.com/enterprises/acme/subject-groups/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","image":"https://wwww.example.net/abc123","translations":{"name":[{"language":"en","value":"Lorem ipsum"}]},"color":"#89d0c1","order":5}'

Request examples

# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *

# Payload
{
  "externalId": "ABCD1234",
  "image": "https://wwww.example.net/abc123",
  "translations": {
    "name": [
      {
        "language": "en",
        "value": "Lorem ipsum"
      }
    ]
  },
  "color": "#89d0c1",
  "order": 5
}

Response examples (200)

{
  "data": {
    "id": "123",
    "color": "#89d0c1",
    "order": 5,
    "externalId": "ABCD1234",
    "image": "https://wwww.example.net/abc123",
    "name": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "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"
        }
      ]
    }
  }
}

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": {}
    }
  ]
}