Skip to main content
POST
Unlock contact phone numbers

Authorizations

Authorization
string
header
required

Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.

Headers

x-call-source
enum<string>
Available options:
api,
agent

Body

application/json
personnel_ids
string[]
required
Required array length: 1 - 100 elements
event_id
string
required
Required string length: 1 - 100

Response

Phone unlock submission accepted, or completed with no chargeable work

status
enum<string>
required

accepted when an asynchronous task was created; success when there was no chargeable work to enqueue.

Available options:
accepted,
success
Allowed value: "accepted"
task_id
string
required

TaskCenter identifier. Present when status is accepted.

job_id
string
required

Alias of task_id. Present when status is accepted.

skipped_personnel_ids
string[]
skipped_detail
object