Takes in an audience id/reference along with a new name and/or reference and/or parentId for the audience.
HTTP Basic authentication using your Tenant ID and API secret.
- Username is the Tenant ID (i.e.
eu-west-2_AbcdEfghI) - Password is the API secret you would have received.
You can also authenticate using OAuth 2.0 client credentials (oauth2 security scheme) instead of Basic auth.
OAuth 2.0 client credentials authentication.
Use the following token endpoints (replace :tenantId with your Tenant ID):
Public API access tokens
- Staging:
https://public.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://public.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://public.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://public.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
Webhooks access tokens
- Staging:
https://user.api.learnstaging.link/oauth2/token/:tenantId - Production:
https://user.api.learn.link/oauth2/token/:tenantId - Staging MEA:
https://user.api.meastaging.learn.tech/oauth2/token/:tenantId - Production MEA:
https://user.api.mea.learn.tech/oauth2/token/:tenantId
- Staging:
All access tokens must be sent using the Authorization: Bearer <access_token> header.
Scopes
For API access (non-webhooks), the following scopes are available:
api/all– Full read and write access to the API.api/read– Read-only access to the API.api/write– Write access to the API.
For webhooks, the following scopes are available:
api/webhooks– Access to webhook functionality.api/all– Full read and write access to the API, including webhooks.
Tokens must include appropriate scopes for the endpoints you wish to call.
Filter by audienceId or audience reference.
Audience Metadata with parentId
The name of the audience.
The external reference for the Audience.
The id of the parent audience/ structure you want to move the audience to.
Audience with member operations, memberOperations is null if the audience was not moved to a new parent.
A audience object with member operations.
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.
The member operations for the audience
A success response for adding members/managers.
An object describing the successfully proccessed entities
The number of entities that have been successfully processed
The reference for the entity.
A success response for adding members/managers.
An object describing the successfully proccessed entities
The number of entities that have been successfully processed
The reference for the entity.
Audience with member operations, memberOperations is not null if the audience was moved to a new parent and some members could not be removed from the old parent.
A audience object with member operations.
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.
The member operations for the audience
A success response for adding members/managers.
An object describing the successfully proccessed entities
The number of entities that have been successfully processed
The reference for the entity.
A partial success response for adding members/managers.
An object describing the successfully proccessed entities
The number of entities that have been successfully processed
The reference for the entity.
An object describing the entities that have been unsuccessfully proccessed
The number of entities that have been unsuccessfully processed
The reason for the failure
The reference for the entity.
Bad Request
Bad Request
Unauthorized
Unauthorized
Forbidden
Forbidden
Not Found
Not found
Conflict
Conflict
Unprocessable Content when updating an audience and moving it to a new parent.
Unprocessable Content when updating an audience and moving it to a new parent.
A partial success response for adding members/managers.
An object describing the successfully proccessed entities
The number of entities that have been successfully processed
The reference for the entity.
An object describing the entities that have been unsuccessfully proccessed
The number of entities that have been unsuccessfully processed
The reason for the failure
The reference for the entity.
Internal Server Error
Internal Server Error