Xurel Docs

Audiences & Contacts

Audiences group contacts for broadcasts. Contacts hold email, name, and custom properties.

Audiences

POST /v1/audiences
Field Type Required Description
name string Required Audience display name.
GET /v1/audiences
GET /v1/audiences/{id}
DELETE /v1/audiences/{id}
Audience
{
  "id": "aud_onboarding",
  "name": "Onboarding",
  "createdAt": "2026-06-01T00:00:00Z"
}

Contacts

POST /v1/audiences/{audienceId}/contacts
Field Type Required Description
email string Required Contact email (unique per audience).
firstName string Optional First name merge field.
lastName string Optional Last name merge field.
unsubscribed boolean Optional Global unsubscribed flag.
properties object Optional Custom properties for segments.
GET /v1/audiences/{audienceId}/contacts
GET /v1/audiences/{audienceId}/contacts/{id}
PATCH /v1/audiences/{audienceId}/contacts/{id}
DELETE /v1/audiences/{audienceId}/contacts/{id}