Sign in
latestOpenAPI 3.1.0MIT2026-08-177111141.8 KB

c4c26e52b406

Messages

Get the status of batches by metadata

Retrive the status of batches that match the metadata provided.

get/v1/projects/{project_id}/messages

Query parameters

metadataKeystring required
Example:campaign_id

The key of the metadata to filter batches by.

metadataValuestring required
Example:my_campaign_123

The value of the metadata to filter batches by.

Response

OK

batch_idstring

The ID of the batch of messages.

meta_dataobject

The metadata associated with the batch of messages.

status'READY' | 'SCHEDULED' | 'PROCESSED' | 'CANCELLED'

The status of the batch of messages.

send_afterstring ISO 8601

The date and time when the batch of messages is or was scheduled to be sent to recipients.