Coming soon. This endpoint is not available yet, and the details below may change before release.
Publishes a content record, making it visible in the catalogue.
The content must already be ready. Publishing anything else returns 409. For content with an upload item the sequence is: create, upload the artefact, then poll GET /rest/v1/contents/{id} until the status it returns for the record is ready, and publish. Remember that readiness also requires a processed thumbnail.
This is the only place skills and topics can be set on content that was not created with publishWhenReady. Send the full set you want the content to carry — the values in this request replace whatever was staged earlier, they are not merged with it.
publishedAt lets you record an original publish date, which is what you want when importing content that was first published elsewhere. Omit it and the content is stamped with the current time.
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.
Unique identifier of the content item
Publish with a backdated publish date
Publishes content that has reached ready, applying the skills and topics it should carry and recording the date it was originally published elsewhere.
{
"authorRef": "UID30084022",
"skills": [
"leadership"
],
"topics": [
"onboarding"
],
"publishedAt": "2024-03-01T00:00:00.000Z"
}The skills, topics and publish date to apply as the content is published.
The complete set of skills the published content should carry. Sending this field replaces any skills supplied when the content was created; omitting it keeps them.
The complete set of topics the published content should carry. Sending this field replaces any topics supplied when the content was created; omitting it keeps them.
The publish date to record. Use this when importing content that was originally published elsewhere. Defaults to the current time.
The published content
Published
Every item has reached ok and the content is now live in the catalogue.
{
"id": "5f9d88d6e1b2a34c56d78902",
"status": "published",
"items": [
{
"id": "5c8936159ec2d00010cdd334",
"type": "elearning",
"rank": "0",
"summary": "Onboarding course",
"status": "ok"
}
]
}What the publish, archive and restore endpoints return: the record's identifier, its lifecycle status, and the state of its items. This is not the same shape as the GET /contents/{id} read, which returns the catalogue view of a record.
Unique identifier for the content
Lifecycle status of a content record. Note this is a different vocabulary from the statuses filter on GET /contents, which uses the legacy values created, published, archived and deleted.
The items that make up the content, with per-item processing state
One item within a content record, with its processing state.
Unique identifier for the item
The item type
The item's position within the content, lowest first
A short label for the item, shown to learners
The item's processing state. An item must reach ok before the content can become ready.
Why processing failed, when status is error
Unauthorized
Unauthorized
Forbidden
Forbidden
Not Found
Not found
Conflict — the content is not ready, so it cannot be published yet. Check per-item status and the thumbnail on GET /rest/v1/contents/{id}.
There was a conflict with the request and the resource
Unsupported Media Type — Content-Type must be application/json
The request could not be processed due to a validation error
Unprocessable Content
Unprocessable Content
Bad Gateway
The request could not be completed because a service it depends on failed. For write operations the content was not modified.
An unexpected error has occurred
When any default error occurs it may be a system failure and persistent errors may require support.
The server is unable to process the request