Add a new audience or updates an existing audience
Key | Value(s) | Description |
---|---|---|
method | "AudiencePush" | Add a new audience or updates an existing audience |
name | "Audience name" | Audience name - must be unique in project |
tags | [ "tag1", "tag2" ] | tags are used to control the display of audiences in the audience builder app |
overwrite | true/false | Optional. default = ??. If true, existing audience will be overwritten. If false and audience exists, error message "An audience named 'xxxxxx' already exists" will be returned. |
audienceId | "NNNN" | When an audience is pushed for the first time the server will generate a new audience id. This is provided by access server and is an integer. |
expiryDate | "DateString" | reserved for future use |
clientMeta | { "clientID": "" "clientAcronym":"" "projectNumber":"" } | extensible metadata |
- audience is identified by 'name'
- an error will be thrown if that audience already exists and 'overwrite' is false
- new audiences have a default 'status' of "draft" and 'archiveStatus' "active"
- this call cannot be used to change either status
When an audience is pushed for the first time the server will generate a new audience id. This is provided by access server
Returns 'added' : true or errors.