Save an audience
save_audienceSaves an audience definition under a name, shared across the organisation, or updates a saved one when audience_id is given. Use it when the user wants to keep, share or recount a list later; saving is free and needs audiences:write. Repeating the same call returns the same saved audience. Call list_audiences to find it again, or count_audience with its aud_ id. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| brief | No | ||
| audience | No | ||
| audience_id | No | A saved audience to update. Leave it out to save a new one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Format: an audience id: aud_ followed by a 26 character ULID in upper case Crockford base32, such as aud_01JB4H2K9V6XN3M9R6T1Y5W8ZA. | |
| url | Yes | The audience in the app, mydatahub.emailmovers.com/audiences/{id}. | |
| name | Yes | ||
| brief | Yes | The brief it was compiled from, if any. | |
| audience | Yes | ||
| created_at | Yes | ||
| created_by | Yes | Format: a user id: usr_ followed by a 26 character ULID in upper case Crockford base32, such as usr_01JA0Q3V7XN3M9R6T1Y5W8ZAK8. | |
| updated_at | Yes | ||
| current_count | Yes | ||
| last_refreshed_at | Yes |