listRecipients( )


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.

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

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

Method Declaration
Copy
Method Parameters
campaignIdstringRequired

Campaign ID.


activityRecipientsActivityEnumRequired

Email activity to filter.


optionsListRecipientsOptions

Options to use when getting the list of recipients.

Returns
Return Type:Promise<ListRecipientsResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?