The request object can contain the following fields:
Field | Modifier | Type | Description |
---|---|---|---|
audience_name | Required | String | A descriptive name for your audience. ---- Although the API does not validate the audience name for uniqueness, it is good practice to choose a unique name. |
ttl_in_hours | Optional Default = 8760 (1 year) | Integer | Period of time (in hours) for which a give user will belong to this audience. |
exclude_from_campaigns | Optional Default = false | Boolean | If set to true , this audience will be suppressed for ALL campaigns (new and existing). |
If you leave out the
ttl
param, the default value is 8760 (1 year).
All field values are final - they cannot be changed once the audience has been created.