listRecipients( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of recipients for a selected campaign based on a specific recipient activity.

Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.

Use List Statistics to retrieve a list of activity for selected campaigns. Use List Campaigns to retrieve additional information for your campaigns.

If no activity is included, this endpoint returns an error.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Email Marketing
Manage Email Marketing
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
campaignIdstringRequired

Campaign ID.


activityRecipientsActivityEnumRequired
8 enum supported values:
BOUNCEDCLICKEDDELIVEREDNOT_OPENEDNOT_SENTOPENEDSENTUNKNOWN

Required. Email activity to filter for. One of:

  • 'DELIVERED'
  • 'OPENED'
  • 'CLICKED'
  • 'BOUNCED'
  • 'NOT_SENT'

optionsListRecipientsOptions

Options to use when getting the list of recipients.

Returns
Return Type:Promise<ListRecipientsResponse>
Was this helpful?
Yes
No