Get Bulk Action Campaigns

GET 
/emails/campaigns/bulk-actions

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Get list of bulk action campaigns for a location

Request

Version stringrequired

API Version

Available options2023-02-21

locationId 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:10

offset number

Number of campaigns to skip for pagination. Defaults to 0, minimum is 0

Possible values: >= 0

Default value:0

dateFrom string

Filter by start date (ISO 8601 format)

dateTo string

Filter by end date (ISO 8601 format)

status string

Filter by status

Available optionsprocessingscheduledpausedcompletecancelled

application/json

Success

application/json

Schema

Schema

campaignsobject[]required

List of bulk action campaigns

totalnumberrequired

Total count of bulk action campaigns

Example (auto)

{
  "campaigns": [
    {
      "id": "OI72xYec4Mho6VBykTvj",
      "name": "Test Mail",
      "status": "complete",
      "scheduleType": "NOW",
      "createdBy": "John Doe",
      "deleted": false,
      "createdAt": "2025-07-24T11:55:43.598Z",
      "updatedAt": "2026-02-09T04:49:12.322Z",
      "completedAt": "2025-07-24T11:55:48.000Z",
      "emailMetadata": {
        "subject": "Welcome to our platform",
        "from": "John Doe <[email protected]>",
        "name": "John Doe",
        "templateId": "6790aeb53c8d1288f555f92b"
      }
    }
  ],
  "total": 25
}