Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Path Parameters

id
string
required

The phone number's id: the id from the list for this resource.

Body

application/json
action
enum<string>
required

Action returned by the Sendora API.

Available options:
release,
retry,
test_message,
send_documents
body
string | null

test_message: the text to send to the workspace's test phone; default is a short check message

Maximum string length: 320
confirm_unassign
boolean
default:false

release: also remove the number from the campaigns, agents and pools that use it

values
RegulatoryRequirementValue · object[] | null

send_documents: [{requirement_id, field_value}] for what the carrier asked

Maximum array length: 20

Response

Successful Response