HollrAI APIBatches

Reschedule a batch’s contacts and/or timing

View as Markdown

Changes a batch’s contacts and/or scheduled_for and pushes the change to the call server. Use this (not the PATCH batch endpoint) whenever contacts or timing need to hit the queue.

Authentication

hollr-api-keystring

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

Path parameters

batch_idstringRequiredformat: "uuid"
UUID of the batch.

Request

This endpoint expects an object.
contactslist of objectsOptional
scheduled_fordatetimeOptional
ISO 8601 timestamp with an explicit UTC offset. Must be in the future. A bare timestamp without a timezone designator is rejected rather than guessed.

Response

Batch rescheduled.
statusstringOptional
batchobjectOptional

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