B2BROKERB2BROKER
MCP
B2COREB2CORE IBB2TRADERB2CONNECTB2TRANSLATEB2BROKER
Client Labels

Update Client Label

Renames and recolours a custom label. System labels are immutable and are rejected with 422; the `code` is left untouched by a rename.

PATCH
/api/v2/client-labels/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*integer

Client label identifier

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/client-labels/3" \  -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": "Not Found"  }}
{  "error": {    "message": "Unprocessable Entity"  }}
{  "error": {    "message": "Too Many Requests"  }}
{  "error": {    "message": "Service Unavailable"  }}
PreviousCreate Client Label POSTNextDelete Client Label DELETE