Block an agent and trigger automatic remapping

View as Markdown

Marks an agent as blocked with an optional reason, then attempts to remap all of its active user-number mappings to an available agent.

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.
reasonstringOptional

Response

Agent blocked
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error