Create integration

Registers a new LMS integration for the company. Once created, use the providerIdentifier as the provider-identifier path parameter to push training content and submit learner progress.

Before using this endpoint:

  • Obtain the provider identifier from your Learning provider — this is the stable key used to register the integration.
  • If you are using a service user, ensure it has the relevant permissions. See Required permissions.
  • If you are developing an app, ensure it has the relevant scopes. See Required permissions.

Testing notes: Open the Examples panel and select a Request Example to inspect the body parameters.

Body Params

Request body for creating an LMS integration (flat structure).

string
required

Stable provider key (for example unlinked). Validated by PartnerIntegrationResolver.validateProviderIdentifier.

string

Display name for the integration. If omitted or blank, defaults to {providerIdentifier}_Integration. Maximum length 256 characters.

Responses
200

Integration created successfully. Response body is empty.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json