Sales Engine
API documentation
OpenAPI Get a key
CampaignsOperation campaigns.audience

Campaigns audience

Next on the Leads step: save the filters and approve everyone ticked in that they match; the rest are left out.

POST/api/v1/campaigns/{id}/audience
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Path

NameInDescription
idrequiredpathThe record's id.

Body

A JSON object. Fields not listed are ignored.

NameInDescription
filtersbody, objectSame shape as audience_filters on campaigns.update; omitted uses the saved filters.

Example

curl
curl -X POST "https://crm.ashwanth.dev/api/v1/campaigns/{id}/audience" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "filters": {}
}'
CLI
sales-engine campaigns audience <id>

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape
{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.
Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
required
The record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/campaigns/%7Bid%7D/audience
Fill the path first.

Also in Campaigns

GET List campaignsPOST Create a campaignGET Get a campaignPATCH Update a campaignDELETE Delete a draft campaignPOST Import lead lists into a campaignDELETE Campaigns remove listsGET List the leads in a campaignPOST Approve, reject or add campaign leadsPATCH Campaigns lead outcomeGET Campaigns signature defaultsPOST Campaigns suggest nameDELETE Remove a lead from a campaignGET Campaigns get workflowPUT Campaigns set workflowPOST Set the campaign sequencePATCH Edit a campaign stepPOST Campaigns set formatPOST Campaigns rewrite stepPOST Write the campaign copyGET Preview the rendered emailsGET Get one lead's copyPATCH Edit one lead's copyPOST Send a test emailGET Get the launch checklistPOST Launch a campaignPOST Pause, resume or cancel a campaignGET Get the campaign timelineGET Campaigns warningsGET List the emails a campaign sentGET Get campaign analyticsGET List reactivation candidatesPOST Create a reactivation campaignPOST Build a reactivation campaign from filters