v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Integrations

Create an integration configuration

🔑

Required OAuth scope: integrations:write.

Create an integration configuration.

post/api/v2/integrations

Headers

360-api-version'v2.0' required

The version of the API.

Request body

defaultCompletionboolean

True if the content is auto-completed at launch; false otherwise.

defaultProgressinteger

The completion rate at launch as a percentage.

noGroupPropagationboolean

If true, the content is visible only within the integration group and is not propagated to subgroups. If false, the content is propagated to all subgroups.

externalPlatformLogoUrlstring

The URL of the logo of the external platform this integration is created for. The URL must be a valid HTTPS URL pointing to a logo with transparent background.

externalPlatformUnicolorLogoUrlstring

The URL of the unicolor logo of the external platform this integration is created for. The URL must be a valid HTTPS URL pointing to a logo with transparent background. If none is provided, the externalPlatformLogoUrl logo will be used.

externalPlatformstring required

The identifier of the external platform this integration is created for.

authorIdstring ObjectId required

The unique ID of the author of the imported content.

groupIdstring ObjectId required

The unique ID of the group to which the content is imported.

Example request

{
  "externalPlatform": "My Platform",
  "authorId": "507f1f77bcf86cd799439011",
  "groupId": "507f1f77bcf86cd799439011"
}

Response

Returns the created integration configuration.