POST

Get Audience


Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Access Verticals by Automations
Set Up Automations
Manage Email Marketing
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/audience

Path Params
campaignIdstringRequired

Campaign ID.

Response Object
audienceAudience

Campaign audience.

Get Audience
Request
cURL
curl -X POST 'https://www.wixapis.com/email-marketing/v1/campaigns/11ab3908-c40e-4deb-8e42-ca743f73ac8b/audience' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "audience": { "contactIds": [ "6a5e3cd4-233e-4d84-9418-bdf3abe332da", "b641f20c-f033-489d-8f57-a2cfe2ae3845" ], "labelIds": ["13ac190d-8c00-47fd-8a33-69b5032a3ac7"], "segmentIds": [ "2d3e7da2-135e-4050-a122-fa6c186d8ced", "23b786de-02fa-47fb-b37b-456fb5f6fd0d", "c92f529f-d559-4cf9-84f0-5a576db99f64" ], "contactsFilter": { "id": { "$in": ["3e229a21-f113-41bf-9e51-af923294180a"] } }, "activeContactsOnly": true } }
Errors

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

Did this help?