Skip to main content
PUT
Bind an assistant to a number

Authorizations

Authorization
string
header
required

Personal access token (izap_pat_…) sent as Authorization: Bearer ; dashboard session JWTs are also accepted.

Headers

business-id
string | null
required

UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.

Path Parameters

number_id
string
required

Body

application/json

null detaches whichever assistant currently answers on the number.

assistant_id
string<uuid> | null

Response

Successful Response

id
string<uuid>
required
phone_number
string
required
assistant_id
string<uuid> | null
assistant_name
string | null
code_verification_status
string | null
display_phone_number
string | null
messaging_backend
enum<string>
default:izap
Available options:
external,
izap
phone_number_id
string | null
platform_type
string | null
quality_rating
string | null
status
string | null
verified_name
string | null
waba_id
string | null