Update Label

Changes a label's name, colour or external id.

PUT

/api/v1/labels/{labelId}

Changes a label's name, colour or external id. The label keeps its id, so everything it is already assigned to keeps the label; only how it is shown changes. Fields you leave out are left as they are.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

labelId*string

The ID of the label to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

The label's new name. Left as it is when omitted.

Length1 <= length

Example"ERP"

colorHex?string

The label's new colour, as a hex code. Left as it is when omitted.

Match^#[A-Fa-f0-9]{6}$

Example"#3B82F6"

externalId?|

Your own identifier for the label. It must be unique within the team. Left as it is when omitted; pass null to clear it.

Example"erp-routing-inbox"

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/labels/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true,  "label": {    "id": "lbl_01JQZ8X0M4T7RB6K9V2NDHW3PA",    "teamId": "string",    "externalId": "erp-routing-inbox",    "name": "ERP",    "colorHex": "#3B82F6",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

500application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`