Takes in an audience id/reference and an array of user emails/refs/ids which already exist on the Thrive system.
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.
An array of user emails/refs/ids which already exist on the Thrive system. This operation replaces all existing members with the provided list. To keep existing members, include them in this list along with any new members.
Note: API operations return a 207 status code for partial success when some users could not be added. See the Audience Workflow Documentation for details on handling these responses.
An object containing the count of successfully processed entities and an array of the entity identifiers.
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.
An object containing the count of successfully/unsuccessfully processed entities and an array of the relevant entity identifiers.
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
Unprocessable Content
Internal Server Error
Internal Server Error