Sign in
Audiences

Create an audience.

An audience is a named segment of leads. Create one to group leads before generating pages for them, or to keep a list you can link to a campaign.

post/api/external/v1/audiences/create

Request body

workspace_idinteger required

The workspace to create it in.

namestring required

What to call it.

descriptionstring nullable

Optional note.

colorstring nullable

Optional hex colour for the dashboard.

lead_idsinteger[]

Leads to put in it immediately.

Example request

{
  "workspace_id": 55,
  "name": "Enterprise prospects",
  "description": "Q3 outbound list",
  "color": "#4F46E5",
  "lead_ids": [
    56789,
    56790
  ]
}

Response

audience_idinteger
namestring
descriptionstring
lead_countinteger

Example response

{
  "audience_id": 44,
  "name": "Enterprise prospects",
  "description": "Q3 outbound list",
  "lead_count": 2
}

Changes