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. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
locationIdstringrequired
Location ID
Example:
ve9EPM428h8vShlRW1KTQuery Parameters
sourcestringrequired
Which audience source to list: tag, smart_list (the calling user’s saved smart lists) or segment (engagement segments).
Available options
tagsmart_listsegmentExample:
smart_listquerystring
Free-text search, where the source supports it
Example:
viplimitnumber
Maximum number of options to return
Possible values: <= 50
Default:
20Example:
20skipnumber
Number of options to skip before the first one returned
Default:
0Example:
0Response
Success
optionsobject[]required
Options on this page
totalnumberrequired
Total matches upstream, not the page length
Example:
42hasMorebooleanrequired
Whether another page exists
Example:
true