Bulk sends

GET /v1/bulk-sends

List Bulk Sends

Query

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

Responses

• 200 BulkSendPage (application/json): Successful Response
• 401 ProblemDetails (application/problem+json): /problems/unauthenticated
• 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
• 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
• 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
• 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
• 500 ProblemDetails (application/problem+json): /problems/engine-error
• default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

POST /v1/bulk-sends

Create Bulk Send

Request body (application/json, required)

Responses

• 201 BulkSendOut (application/json): Successful Response
• 401 ProblemDetails (application/problem+json): /problems/unauthenticated
• 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
• 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
• 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
• 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
• 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
• 500 ProblemDetails (application/problem+json): /problems/engine-error
• default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: 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 (application/json): Successful Response
• 401 ProblemDetails (application/problem+json): /problems/unauthenticated
• 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
• 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
• 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
• 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
• 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
• 500 ProblemDetails (application/problem+json): /problems/engine-error
• default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

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

Cancel Bulk Send

Path

• bulk_send_id string (uuid)

Responses

• 200 BulkSendOut (application/json): Successful Response
• 401 ProblemDetails (application/problem+json): /problems/unauthenticated
• 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
• 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
• 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
• 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
• 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
• 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
• 500 ProblemDetails (application/problem+json): /problems/engine-error
• default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.

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

Dispatch Bulk Send

Path

• bulk_send_id string (uuid)

Responses

• 202 BulkSendOut (application/json): Successful Response
• 401 ProblemDetails (application/problem+json): /problems/unauthenticated
• 402 ProblemDetails (application/problem+json): /problems/live-mode-unavailable
• 403 ProblemDetails (application/problem+json): Workspace entitlement or access denied.
• 404 ProblemDetails (application/problem+json): Resource not found or not accessible to this key.
• 409 ProblemDetails (application/problem+json): Invalid state, conflict, or idempotency key conflict.
• 422 ProblemDetails (application/problem+json): Request schema or semantic validation failed; inspect type and detail.
• 429 ProblemDetails (application/problem+json): /problems/rate-limited; retry after Retry-After seconds.
• 500 ProblemDetails (application/problem+json): /problems/engine-error
• default ProblemDetails (application/problem+json): API error; type identifies the stable problem.

Problem types and recovery steps: error reference.