POST
/
contact
/
call
curl --request POST \
  --url https://api.thoughtly.com/contact/call \
  --header 'Content-Type: application/json' \
  --header 'team_id: <api-key>' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "contact_id": "<string>",
  "interview_id": "<string>",
  "metadata": {
    "additional_data_1": "<string>"
  }
}'
{
  "error": {},
  "data": {}
}

Authorizations

​
x-api-token
string
header
required

API key for the user making the request. This can be found via the Developer Settings page in the dashboard.

​
team_id
string
header
required

Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.

Body

application/json
​
contact_id
string
required

The ID of the Contact that will be called. You cannot call a phone number until you have created a Contact. By creating a contact, you acknowledge that you have the necessary permissions to call the phone number.

​
interview_id
string
required

The ID of the Agent that will be used to make the call. This can be found in the URL of the Agent page.

​
metadata
object | null

Additional data that the Agent can reference during the call using {key_name}. For example, if you include {'additional_data_1': 'value'}, you can reference additional_data_1 in the Agent script as {additional_data_1}.

Response

200 - application/json
Successful response

The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.

​
data
object
required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.

​
error
object | null

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

Was this page helpful?