Skip to main content
cURL

Authorizations

Authorization
string
header
required

Issued in Developers. Workspace/owner/scopes come from credential, never acting-user headers. API keys cannot manage API credentials.

Headers

Idempotency-Key
string
required

Required. Omitting this header returns 400 idempotency_key_required and changes nothing; a value outside the pattern returns 400 idempotency_key_invalid. Persist one key for this logical operation before sending it. Reuse the same value only with the same method, path and body after a timeout. A changed request returns 409 idempotency_conflict; a matching retry returns the original response.

Pattern: ^[A-Za-z0-9._:-]{1,200}$

Path Parameters

id
integer
required

Numeric scheduled call ID.

Required range: 1 <= x <= 2147483647

Body

application/json
scheduledAt
string<date-time>

UTC instant. Writes must include Z or an explicit offset.

status
enum<string>

Explicit record status, consistent with the existing app. Completed status alone is not proof of dialing. Cancelling a completed callback returns 409 through PATCH or DELETE.

Available options:
Pending,
Completed,
Failed,
Cancelled
notes
string | null
Maximum string length: 16000

Response

Scheduled call result.

id
integer
required
ownerId
string
required
contactId
integer
required
phoneNumber
string
required
scheduledAt
string<date-time>
required

UTC instant. Writes must include Z or an explicit offset.

status
enum<string>
required
Available options:
Pending,
Completed,
Failed,
Cancelled
notes
string | null
required
callHistoryId
integer | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
timeZone
string | null
required
timeZoneSource
string
required