List Bulk Action Campaigns
GET/emails/locations/:locationId/campaigns/bulk-actions
Get list of bulk action campaigns for a location
Request
Version stringrequired
API Version
Available options
v3locationId stringrequired
Location ID
limit number
Number of campaigns to return. Defaults to 10, minimum is 1, maximum is 20
Possible values: >= 1 and <= 20
Default value:
10offset number
Number of campaigns to skip for pagination. Defaults to 0, minimum is 0
Possible values: >= 0
Default value:
0search string
Search query to filter campaigns.
Default value:
dateFrom string
Filter by start date (ISO 8601 format)
dateTo string
Filter by end date (ISO 8601 format)
status string
Filter by status
Available options
processingscheduledpausedcompletecancelledSuccess
- application/json
- Schema
- Example (auto)
Schema
campaignsobject[]required
List of bulk action campaigns
totalnumberrequired
Total count of bulk action campaigns
traceIdstring
Trace ID of the request
{
"campaigns": [
{
"id": "OI72xYec4Mho6VBykTvj",
"name": "Test Mail",
"status": "complete",
"deleted": false,
"createdAt": "2025-07-24T11:55:43.598Z",
"updatedAt": "2026-02-09T04:49:12.322Z"
}
],
"total": 25,
"traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}