Creates an assignment for a specific 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.
Request body for creating an assignment
The audience ID
The content ID for the primary content
The content IDs which can cause the assigned content to be completed
Whether to show or hide the alternative content
The number of days required to complete the assignment
The number of days until the assignment will reoccur
The assignment
A content item assigned to a specific audience
The assignment ID
The audience ID
The content ID for the primary content
The content IDs which can cause the assigned content to be completed
Whether to show or hide the alternative content
The number of days required to complete the assignment
The number of days until the assignment will reoccur
Defines whether the assignment is active
Defines whether the assignment is deleted
An ISO8601 for the timestamp when the assignment was created
An ISO8601 for the timestamp when the assignment was deleted
An ISO8601 for the timestamp when the assignment was last modified
Unauthorized
Unauthorized
Forbidden
Forbidden
Unprocessable Content
Unprocessable Content
Internal Server Error
Internal Server Error