Sign in
Labels

Create a Label

Creates a new Label on the authenticated user's organisation. Labels are then available to attach to any Customer in the organisation for ad-hoc segmentation in reports and Customer Hub searches.

post/customers/labels

Request body

valuestring required

Display text shown on the label badge against a customer. Operator-facing only — there is no guest-visible surface for labels. Limited to 20 characters so the badge fits in customer-list rows.

colourstring required

A hex colour code excluding the preceding # which this label will be rendered as.

organisation_idstring uuid

The organisation which this label belongs to

Example request

{
  "value": "VIP",
  "colour": "ff6634",
  "organisation_id": "000000-000000-000000-000000"
}

Response

The label was successfully retrieved

Example response

{
  "data": {
    "id": "000000-000000-000000-000000",
    "value": "VIP",
    "colour": "ff6634",
    "organisation_id": "000000-000000-000000-000000",
    "created_at": "2021-01-01T00:00:00.000Z",
    "updated_at": "2021-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.