Create job
This endpoint allows you to create a job to trigger an Agent to call many contacts provided by their IDs or phone numbers.
Authorizations
API key for the user making the request. This can be found via the Developer Settings page in the dashboard.
Team identifier, used to scope requests to a specific team. This can be found via the Developer Settings page in the dashboard.
Body
The ID of the Agent (formerly Interview) that will be used to make the call. This ID can be found in the URL of the Agent page. The Agent is responsible for the conversation flow during the call.
A list of Contact IDs to call. You can pass multiple Contact IDs to call multiple contacts.
A list of phone numbers to call directly if you don't want to use Contact IDs.
The country code for the phone numbers being dialed (e.g., '+1' for the USA).
Response
The generic response format for all API requests. This structure ensures consistency in how success and error information is returned to the caller.
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.
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?