GEgenpage
Audiences

Delete an audience. The leads in it are kept.

Changed on

Only the segment is removed. Unlike the dashboard's version, this endpoint has no option to delete the leads themselves: that is irreversible, and nothing about removing a grouping implies destroying the people in it. Leads that were only reachable through this audience remain in the workspace and are still findable with leads/search.

post/api/external/v1/audiences/delete

Request

Request body

workspace_idinteger required

The workspace it belongs to.

audience_idinteger required

From list-audiences.

Example request

{
  "workspace_id": 55,
  "audience_id": 44
}

Response

audience_idinteger
leads_keptinteger
messagestring

Example response

{
  "audience_id": 44,
  "leads_kept": 12,
  "message": "Audience deleted. Its leads were kept."
}

Changes