Pexip Engage API documentation

Override static translations

PATCH /static-translation-overrides

OAuth2

Override static translations by their module, key and language

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.

application/json

Body

module string Required

Values are BACKOFFICE_APP, CALENDAR_EVENT_TEMPLATE, EMAIL_TEMPLATE, INSIGHTS, PLUGIN, TEXT_MESSAGE_TEMPLATE, or VIDEO.
key string Required

Minimum length is 1.
language string Required

Values are da, de, el, en, es, fr, ja, nl, no, or pl.
value string | null

Minimum length is 1.
Additional properties are NOT allowed

Responses

• 200 application/json

Successful operation
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes object
  
  module string Required
  
  Values are BACKOFFICE_APP, CALENDAR_EVENT_TEMPLATE, EMAIL_TEMPLATE, INSIGHTS, PLUGIN, TEXT_MESSAGE_TEMPLATE, or VIDEO.
  
  key string Required
  
  Minimum length is 1.
  
  language string Required
  
  Values are da, de, el, en, es, fr, ja, nl, no, or pl.
  
  value string Required
  
  Minimum length is 1.
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 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

PATCH /static-translation-overrides

curl \
 -X PATCH https://api.pexipengage.com/enterprises/acme/static-translation-overrides \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '[{"module":"CALENDAR_EVENT_TEMPLATE","key":"example.key","language":"en","value":"Lorem ipsum"}]'

Request example

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

# Payload
[
  {
    "module": "CALENDAR_EVENT_TEMPLATE",
    "key": "example.key",
    "language": "en",
    "value": "Lorem ipsum"
  }
]

Response examples (200)

{
  "data": [
    {
      "module": "CALENDAR_EVENT_TEMPLATE",
      "key": "example.key",
      "language": "en",
      "value": "Lorem ipsum",
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    }
  ]
}

Response examples (422)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}