Blast List

Lists campaign blasts for a workshop.

Blast content, audience, and channels are managed in the platform dashboard. This endpoint returns blast metadata for listing and selecting a blast to trigger or inspect.

Optional query parameter status filters by blast status. When omitted, blasts of any status for the workshop are returned.

Partner authentication is required. The workshop must have partner integration enabled and blast messaging available. Requests from unauthorized partners or for disabled workshops return 403.

Supported `status` values

`status`	Description
`submitted`	Submitted and awaiting approval
`approved`	Approved and ready to trigger
`rejected`	Rejected
`completed`	Already sent
`failed`	Send failed

Unsupported status values return 400 with error code 000001.

HTTP	errorCode	When
400	`000001`	Unsupported `status` query value
401	`010000`	Missing or invalid OAuth token
403	`000003`	Feature unavailable
403	`000004`	Partner integration or blast messaging disabled for the workshop
404	`030001`	Workshop not found

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

SuccessEmpty List

{
    "success": true,
    "blasts": [
        {
            "blastId": "64f1a2b3c4d5e6f7a8b9c0d5",
            "title": "Winter service special",
            "status": "approved",
            "recipientCount": 123
        },
        {
            "blastId": "64f1a2b3c4d5e6f7a8b9c0d6",
            "title": "Service due reminder promo",
            "status": "completed",
            "recipientCount": 45
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠401Unauthorized

🟠404Not Found

Supported status values#

Request

Request Code Samples

Responses

Supported `status` values