API Reference
Audiences
Organize contacts into audiences for targeted campaign sends.
Audiences are named groups of contacts. You assign contacts to audiences, then target an audience when creating a campaign.
Create audience
POST /v1/audiences
Requires full_access scope.
Request body
{
"name": "Newsletter Subscribers"
}
Response
{
"id": "aud_abc123",
"name": "Newsletter Subscribers",
"contact_count": 0,
"created_at": "2025-03-12T09:00:00Z"
}
Get audience
GET /v1/audiences/:id
Requires read_only scope.
List audiences
GET /v1/audiences
Requires read_only scope.
{
"data": [
{
"id": "aud_abc123",
"name": "Newsletter Subscribers",
"contact_count": 4200,
"created_at": "2025-03-12T09:00:00Z"
}
],
"has_more": false,
"next_cursor": null
}
Update audience
PATCH /v1/audiences/:id
Requires full_access scope.
Delete audience
DELETE /v1/audiences/:id
Requires full_access scope.
Add contacts to audience
POST /v1/audiences/:id/contacts
Requires full_access scope.
{
"contact_ids": ["con_abc123", "con_abc124"]
}
Remove contacts from audience
DELETE /v1/audiences/:id/contacts
Requires full_access scope.
{
"contact_ids": ["con_abc123"]
}
Plan limits
| Plan | Audiences |
|---|---|
| Free | 3 |
| Pro | 25 |
| Business | Unlimited |
| Enterprise | Unlimited |