Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

enterprise_id
string<uuid>
required

The enterprise id. Lowercase UUID.

Example:

"4a6192a4-573d-446d-b3ce-aff9117272a6"

Body

application/json
phone_numbers
string[]
required

Phone numbers in E.164 format. Each must belong to this enterprise. Maximum 2,000 per request.

Required array length: 1 - 2000 elements
Pattern: ^\+[1-9][0-9]{9,14}$
call_purpose
string
required

How the numbers are used (free text).

Required string length: 1 - 2000
Example:

"Appointment reminders for our dental clinic."

contact_email
string<email>

Optional contact email for this remediation request.

Maximum string length: 255
Example:

"ops@example.com"

webhook_url
string<uri>

Optional https:// URL for status notifications.

Maximum string length: 2048
Example:

"https://example.com/webhooks/remediation"

Response

Remediation request accepted and persisted.

data
object
required

Full detail of a remediation request, returned on submit and GET by id.