Skip to main content
PATCH
Assign an iMessage Number
Safety and behavior notes
  • A malformed workflow_id is not guaranteed to produce a clean HTTP 400 response.
  • Assigning an agent group releases any other number already assigned to that group.
  • Omitting workflow_id unbinds the number; omission is not a no-op.
  • Unbinding leaves the number active and billed, so review the optional workflow_id field before submission.
  • The route’s id pattern is weaker than full UUID validation.
  • Unbinding does not cancel ownership or recurring charges.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string
required

iMessage number id. Pinned handler checks only 36 hex-or-hyphen characters, not canonical UUID groups. Callers should send a real UUID.

Pattern: ^[0-9a-f-]{36}$

Body

application/json
workflow_id
string<uuid> | null

Target workflow. Omit, null, or blank to unbind.

Response

Binding/unbinding result.

success
enum<boolean>
required
Available options:
true
number
object
required
Last modified on September 8, 2026