Skip to main content
CampaignsVersion: v3New

List Audience Options

GET/emails/locations/{locationId}/campaigns/audience-options

Find the tags, smart lists (the calling user’s saved lists) or engagement segments a campaign can target, with the ids to use in Estimate Recipients and Schedule Campaign. Contacts are not listed here.

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

sourcestringrequired

Which audience source to list: tag, smart_list (the calling user’s saved smart lists) or segment (engagement segments).

Available optionstagsmart_listsegment
Example:smart_list
querystring

Free-text search, where the source supports it

Example:vip
limitnumber

Maximum number of options to return

Possible values: <= 50

Default:20
Example:20
skipnumber

Number of options to skip before the first one returned

Default:0
Example:0

Response

Success

optionsobject[]required

Options on this page

totalnumberrequired

Total matches upstream, not the page length

Example:42
hasMorebooleanrequired

Whether another page exists

Example:true