Assign Client Labels

Replaces the client's custom label assignments with the submitted set. An empty array removes all of them. System labels are maintained automatically: they cannot be submitted here (422) and are never removed by this call. The response lists every label the client carries afterwards, system ones included.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

client*integer

Client identifier

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

labels*array<integer>

Ids of the custom labels the client must end up with.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v2/clients/42/labels" \  -H "Content-Type: application/json" \  -d '{    "labels": [      3,      7    ]  }'

{  "total": 0,  "data": [    {      "code": "deposited",      "name": "Deposited",      "kind": "system",      "colour": "#8E44AD"    }  ]}

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

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

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

{  "error": {    "message": "Not Found"  }}

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

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

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

Assign Client Labels

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`