Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "e164": "<string>",
    "provider": "<string>",
    "defaultAgentId": "<string>",
    "monthlyCost": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "label": "<string>"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Numbers

Set or clear a number's display label

Set (or clear) the org-editable display label for an owned number — e.g. “Google Ads” or “Denver line” — which backs the “Calls by number” marketing-attribution widget’s number chip. The label never routes, gates, or affects billing. Pass label as a string (trimmed, at most 64 characters) to set it, or null (or a blank string) to clear it. The label is also ENTRY CONTEXT. A call or text arriving on this number gives the agent the LABEL — never the digits — as {entry.label}, so one agent behind several numbers knows which door the customer came in through. Write it as something an agent could sensibly read (“Denver line”, “Spanish line”, “Spring tune-up”). It is a HINT the agent may use to pre-seed a question it still asks; it is never identity and never satisfies a skill’s parameter binding. See EntryContext.

PATCH

numbers

{id}

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "e164": "<string>",
    "provider": "<string>",
    "defaultAgentId": "<string>",
    "monthlyCost": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "label": "<string>"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

string

required

The owned number's id (from listNumbers).

Body

application/json

label

string | null

Display label (≤64 characters, trimmed). null or blank clears it.

Maximum string length: 64

Response

The updated number.

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes

Using the API

Endpoints

Set or clear a number's display label

Authorizations

Path Parameters

Body

Response