Skip to main content
POST
/
scheduled-calls
/
{customerId}
cURL
curl --request POST \
  --url https://api.example.com/scheduled-calls/{customerId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
[
  {
    "id": "<string>",
    "customerId": "<string>",
    "scheduledTime": "<string>",
    "status": "<string>"
  }
]

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
customerId
string
required

ID of customer

Body

application/json

Schedule type to create calls for

​
scheduleType
enum<string>
required

Type of schedule

Available options:
verification,
collections,
custom

Response

Array of scheduled calls created

​
id
string

Identification number of the scheduled call

​
customerId
string

ID of the customer

​
scheduledTime
string

Scheduled time of the call

​
status
string

Status of the scheduled call