bulk-sends

GET /v1/bulk-sends

List Bulk Sends

Query

• limit integer (>= 1, <= 200) default 50
• offset integer (>= 0) default 0

Responses

• 200 BulkSendPage
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/bulk-sends

Create Bulk Send

Request body (application/json, required)

Responses

• 201 BulkSendOut
• 4xx 5xx application/problem+json; see the error reference.

GET /v1/bulk-sends/{bulk_send_id}

Get Bulk Send

Path

• bulk_send_id string (uuid)

Query

• status string | null

Responses

• 200 BulkSendOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/bulk-sends/{bulk_send_id}/cancel

Cancel Bulk Send

Path

• bulk_send_id string (uuid)

Responses

• 200 BulkSendOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/bulk-sends/{bulk_send_id}/dispatch

Dispatch Bulk Send

Path

• bulk_send_id string (uuid)

Responses

• 202 BulkSendOut
• 4xx 5xx application/problem+json; see the error reference.