Create Client Label

Creates a custom client label. The `code` is derived from `name` and is not accepted from the request: it is the stable identifier logic keys off, so it never changes once assigned.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Writable fields of a custom label. code and kind are not writable: code is derived from name at creation and then fixed, and only custom labels can be written at all.

name*string

Human readable label name. Must be unique across all labels. Capped at the same 64 characters as code, which is derived from it.

Lengthlength <= 64

colour*string

Chip colour. Must be one of the palette values, so that chips stay readable and consistent with the admin panel theme.

Value in

"#26C281"
"#3598DC"
"#8E44AD"
"#E7505A"
"#F2784B"
"#C49F47"
"#1BA39C"
"#4B77BE"
"#8C7873"
"#D05391"
"#95A5A6"
"#525E64"

Response Body

`application/json`

curl -X POST "https://example.com/api/v2/client-labels" \  -H "Content-Type: application/json" \  -d '{    "name": "VIP",    "colour": "#8E44AD"  }'

{  "code": "deposited",  "name": "Deposited",  "kind": "system",  "colour": "#8E44AD",  "id": 1}

{  "error": {    "message": "Bad Request",    "code": 0,    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}

{  "error": {    "message": "Unauthorized"  }}

{  "error": {    "message": "Forbidden"  }}

{  "error": {    "message": "Unprocessable Entity"  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Create Client Label

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`