CampaignsVersion: v3New

List Bulk Action Campaigns

GET/emails/locations/{locationId}/campaigns/bulk-actions

Get list of bulk action campaigns for a location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:emails/campaigns.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT

Query Parameters

limitnumber

Number of campaigns to return. Defaults to 10, minimum is 1, maximum is 20

Possible values: >= 1 and <= 20

Default:10

Example:10

offsetnumber

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

Possible values: >= 0

Default:0

Example:0

searchstring

Search query to filter campaigns.

Default:

Example:action

dateFromstring

Filter by start date (ISO 8601 format)

Example:2024-01-01T00:00:00.000Z

dateTostring

Filter by end date (ISO 8601 format)

Example:2024-12-31T23:59:59.999Z

statusstring

Filter by status

Available optionsprocessingscheduledpausedcompletecancelled

Example:complete

Response

application/json

Success

campaignsobject[]required

List of bulk action campaigns

totalnumberrequired

Total count of bulk action campaigns

Example:25

traceIdstring

Trace ID of the request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4