Assign an agent phone number to an account

View as Markdown

Maps the agent to the authenticated account so it appears in GET /agents. Fails with 409 if the agent is already owned by a different account. The agent does not need to be online to be assigned, but it must register/connect to show as online.

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Path parameters

phoneNumberstringRequired

Request

This endpoint expects an object.
appIdstringOptional

Optional app ID used to build attachment storage paths for this agent’s inbound media. Defaults to the authenticated X-App-Id.

Response

Agent assigned to account
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error