Skip to main content
POST
/
api
/
organizations
/
{organizationId}
/
phone-numbers
Assign or update a phone number on a target user (SuperAdmin only)
curl --request POST \
  --url https://your-instance.example.com/api/organizations/{organizationId}/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetUserId": "5f7b1c2e8a1d4e0012c3b4a6",
  "provider": "twilio",
  "phoneNumber": "+14165550102",
  "isDefault": true,
  "isInboundEnabled": true,
  "label": "Main Outbound"
}
'
{
  "success": true,
  "message": "twilio phone number assigned"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

Body

application/json
​
targetUserId
string
required

User in the organization who should receive the phone-number assignment; must belong to the calling org.

​
provider
string
required

Voice provider for this number: twilio, sinch, or textgrid.

​
phoneNumber
string
required

Phone number to assign in E.164 format (e.g. +14165550102).

​
isDefault
boolean

When true, makes this the user's default outbound number for the given provider (defaults to true if omitted).

​
isInboundEnabled
boolean

When true, routes inbound calls/SMS for this number to the user (defaults to true if omitted).

​
label
string

Optional human-readable label shown alongside the number in the UI (e.g. "Main Outbound").

Response

Phone number assigned

Returned by POST (assign) and DELETE (remove) phone-number endpoints.

​
success
enum<boolean>
required
Available options:
true
​
message
string
required