Takes in the metadata for an audience and creates a new one in the system.
Workflow Steps
- First create a top-level structure (parentId is empty or omitted, category is "structure")
- Then create child audiences within that structure (parentId references the structure, category is "audience")
- Add members to your audiences using the members endpoints
Important Notes
- Audiences created via the API can only be managed via API, not through the Thrive UI
- API-created audiences can only exist within API-created structures
- Each structure/audience needs a unique reference for programmatic identification
For a detailed workflow guide including code examples and best practices, refer to the Audience Workflow Documentation.
To pass the authentication step you will need to provide the following:
Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received
Audience Metadata used when creating or updating an audience
The name of the audience.
The external reference for the Audience.
The id or reference of the parent audience/ structure, this will be blank if it is a parent audience/ structure.
Category of Audience: * structure - Structure, a top-level/parent audience. Created without a parentId. Represents an organizational unit. * audience - Audience, a child audience that exists within a structure. Created with a parentId. The workflow for creating audiences requires first creating a structure (category=structure, no parentId), then creating child audiences within that structure (category=audience, with parentId). A structure may contain multiple child audiences, but each audience can only belong to one structure. When a structure is deleted, all its child audiences are also deleted. See the Audience Workflow Documentation for hierarchy examples.
Audience
A audience object.
The id of the created resource
The name of the audience
The external reference for the Audience
Whether the audience is API controlled or not. API-controlled audiences:
- Can only be updated via the API, not through the Thrive UI
- Must be created using this API (existing UI-created audiences cannot be converted)
- API-created audiences can only exist within API-created structures
- Are always of type 'manual' (not 'smart')
Category of Audience: * structure - Structure, a top-level/parent audience. Created without a parentId. Represents an organizational unit. * audience - Audience, a child audience that exists within a structure. Created with a parentId. The workflow for creating audiences requires first creating a structure (category=structure, no parentId), then creating child audiences within that structure (category=audience, with parentId). A structure may contain multiple child audiences, but each audience can only belong to one structure. When a structure is deleted, all its child audiences are also deleted. See the Audience Workflow Documentation for hierarchy examples.
Type of Audience: * smart - Audience membership is controlled by smart rules. * manual - Audience membership is managed manually. Note: Audiences created via the API are always of type 'manual'. Smart audiences can only be created through the Thrive UI. API-controlled audiences cannot be converted to smart audiences.
Information on the parent audience/ structure - only available on a child audience.
The name of the audience
The external reference for the Audience
The id of the parent audience/ structure.
The DateTime the audience was created at.
The DateTime the audience was last updated at.
Bad Request
Bad Request
Unauthorized
Unauthorized
Forbidden
Forbidden
Conflict
Conflict
Unprocessable Content
Unprocessable Content
Internal Server Error
Internal Server Error