HollrAI APIBatches

Create a batch of calls

View as Markdown

Create a batch of contacts to call under a campaign, either immediately or at a scheduled UTC time. The batch record is created in HollrAI first and kept (as failed) even if enqueueing on the call server fails, so it can be inspected or retried.

Authentication

hollr-api-keystring

API key issued for your account. Every request is logged and rate-limited against this key.

Request

This endpoint expects an object.
campaign_idstringRequiredformat: "uuid"
UUID of the campaign to place the calls under. Campaigns are created in the HollrAI platform.
namestringRequired
contactslist of objectsRequired
run_nowbooleanOptionalDefaults to false

If true, the batch is started immediately. Wins over scheduled_for if both are present.

scheduled_fordatetimeOptional

ISO 8601 timestamp with an explicit UTC offset (e.g. trailing Z or +05:30). Required unless run_now is true or omitted. Must be in the future. A bare timestamp without a timezone designator is rejected rather than guessed — convert local time to UTC before sending.

Response

Batch created and successfully scheduled on the call server.
statusstringOptional
batch_idstringOptionalformat: "uuid"
namestringOptional
batch_statusenumOptional
Current lifecycle status of the batch, kept in sync with the call server.
run_nowbooleanOptional
scheduled_fordatetime or nullOptional
contacts_countintegerOptional
call_server_responsemap from strings to anyOptional
Response is passed through verbatim from the internal call server. Update this schema once the call server's response contract is documented.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error