B2BROKERB2BROKER
MCP
B2COREB2CORE IBB2TRADERB2CONNECTB2TRANSLATEB2BROKER
Client Labels

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.

PUT
/api/v2/clients/{client}/labels

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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"  }}
PreviousDelete Client Label DELETENextGet Rate Providers GET