Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designations

Create a designation

Use this request to create a new designation in your account. Provide a name and an optional code. The designation is created in the account associated with the API key and returned with its details.

post/v1/designations

Request body

namestring required

Designation name.

codestring nullable

Designation code.

livemodeboolean

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Designations only exist in live mode — set this to true.

Example request

{
  "name": "My Designation",
  "code": "Code-1",
  "livemode": true
}

Response

On success, the API returns the created designation object.

codestring nullable required

Designation code.

created_atstring required

Timestamp in ISO 8601 format, indicating when the designation was created in UTC.

idstring required

Unique designation identifier.

is_defaultboolean required

Indicates whether this is the default designation for the account.

namestring nullable required

Designation name.

updated_atstring required

Timestamp in ISO 8601 format, indicating when the designation was last updated in UTC.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "code": "Code-1",
  "created_at": "2024-01-01T00:00:00.000Z",
  "id": "EXXXXXXX",
  "is_default": true,
  "name": "My Designation",
  "updated_at": "2024-01-31T00:00:00.000Z"
}