Skip to main content
Version: v3New

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 optionsv3
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
search 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 optionsprocessingscheduledpausedcompletecancelled
application/json

Success

Schema
    campaignsobject[]required

    List of bulk action campaigns

    totalnumberrequired

    Total count of bulk action campaigns

    traceIdstring

    Trace ID of the request