FlaresendDocs
Audiences

Create an audience

Create a named list of contacts that a broadcast can be sent to.

POST/v1/audiencesAPI key

An audience is a named group of contacts in the project. A contact can be in any number of audiences. New audiences are empty; add contacts with Add contacts to an audience. See Audiences.

Body parameters

namestringrequired

1 to 200 characters. Must be unique in the project.

Response

Status 201 with the audience.

idstring

The audience ID, for example aud_01K6C2A7F3H5J8K1M4N6P9Q2RS.

projectIdstring

The project the audience belongs to.

namestring

How many contacts are in the audience, subscribed or not.

createdAtstring

ISO 8601 creation time.

Errors

StatusCodeWhen
400invalid_bodyname is missing, empty or over 200 characters.
409audience_existsThe project already has an audience with this name.