Licenses

Updates an existing license by ID, replacing or appending its associated courses, learning paths, and course tags, along with any metadata such as name, seat limits, and expiration date

Updates an existing license by ID, replacing or appending its associated courses, learning paths, and course tags, along with any metadata such as name, seat limits, and expiration date.

PUThttps://example.thoughtindustries.com/incoming/v2/licenses/:id

Example request

curl -X PUT "https://example.thoughtindustries.com/incoming/v2/licenses/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "courseIds": "00000000-0000-0000-0000-000000000000",
  "learningPathIds": "00000000-0000-0000-0000-000000000000",
  "courseTagIds": "00000000-0000-0000-0000-000000000000",
  "replaceCourseIds": true
}'

Parameters

Name	Type	Required	Location	Description
`id`	`uuid`	Yes	path	The id identifier.
`courseIds`	`uuid[]`	Yes	body	IDs of the courses to associate with this license.
`learningPathIds`	`uuid[]`	Yes	body	IDs of the learning paths to associate with this license.
`courseTagIds`	`uuid[]`	Yes	body	IDs of the course tags to associate with this license.
`replaceCourseIds`	`boolean`	No	body	When `true`, replaces the existing course list with the provided `courseIds`; when `false`, appends to the existing list.
`replaceLearningPathIds`	`boolean`	No	body	When `true`, replaces the existing learning path list with the provided `learningPathIds`; when `false`, appends to the existing list.
`replaceCourseTagIds`	`boolean`	No	body	When `true`, replaces the existing course tag list with the provided `courseTagIds`; when `false`, appends to the existing list.
`name`	`string`	Yes	body	Display name of the license.
`label`	`string`	No	body	Short label used to identify the license in listings and reports.
`sku`	`string`	No	body	Stock-keeping unit code for the license.
`seatsLimit`	`integer`	No	body	Maximum number of seats available under this license; omit or set to `0` for unlimited.
`parentLicenseId`	`uuid`	No	body	ID of the parent license when this license is part of a hierarchy.
`accessDays`	`integer`	No	body	Number of days a learner retains access to licensed content after enrollment.
`expirationDate`	`ISO 8601 timestamp`	No	body	Date and time at which the license expires, in ISO 8601 format.
`enableBranding`	`boolean`	No	body	When `true`, applies the license-level branding overrides to the learner experience.
`isDefault`	`boolean`	No	body	When `true`, marks this license as the default for its client.
`ref1`	`string`	No	body	Custom reference field 1 for storing external identifiers or metadata.
`ref2`	`string`	No	body	Custom reference field 2 for storing external identifiers or metadata.
`ref3`	`string`	No	body	Custom reference field 3 for storing external identifiers or metadata.
`ref4`	`string`	No	body	Custom reference field 4 for storing external identifiers or metadata.
`ref5`	`string`	No	body	Custom reference field 5 for storing external identifiers or metadata.
`ref6`	`string`	No	body	Custom reference field 6 for storing external identifiers or metadata.
`ref7`	`string`	No	body	Custom reference field 7 for storing external identifiers or metadata.
`ref8`	`string`	No	body	Custom reference field 8 for storing external identifiers or metadata.
`ref9`	`string`	No	body	Custom reference field 9 for storing external identifiers or metadata.
`ref10`	`string`	No	body	Custom reference field 10 for storing external identifiers or metadata.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "courseIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "learningPathIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "courseTagIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "name": "string",
  "label": "string",
  "sku": "string",
  "seatsLimit": 0,
  "enableBranding": true,
  "parentLicenseId": "00000000-0000-0000-0000-000000000000",
  "accessDays": 0,
  "expirationDate": "2024-01-01T00:00:00.000Z",
  "isDefault": true,
  "ref1": "string",
  "ref2": "string",
  "ref3": "string",
  "ref4": "string",
  "ref5": "string",
  "ref6": "string",
  "ref7": "string",
  "ref8": "string",
  "ref9": "string",
  "ref10": "string"
}

Response fields

Field	Type	Description
`id`	`uuid`	Identifier of the license.
`courseIds`	`uuid[]`	Identifiers of courses granted by the license.
`learningPathIds`	`uuid[]`	Identifiers of learning paths granted by the license.
`courseTagIds`	`uuid[]`	Identifiers of course tags granted by the license.
`name`	`string`	Name of the license.
`label`	`string`	Display label of the license.
`sku`	`string`	SKU of the license.
`seatsLimit`	`integer`	Maximum number of seats on the license.
`enableBranding`	`boolean`	Whether custom branding is enabled for the license.
`parentLicenseId`	`uuid`	Identifier of the parent license, when nested.
`accessDays`	`integer`	Number of access days granted by the license.
`expirationDate`	`ISO 8601 timestamp`	Expiration date of the license.
`isDefault`	`boolean`	Whether this is the default license for the client.
`ref1`	`string`	Custom reference field 1 on the license.
`ref2`	`string`	Custom reference field 2 on the license.
`ref3`	`string`	Custom reference field 3 on the license.
`ref4`	`string`	Custom reference field 4 on the license.
`ref5`	`string`	Custom reference field 5 on the license.
`ref6`	`string`	Custom reference field 6 on the license.
`ref7`	`string`	Custom reference field 7 on the license.
`ref8`	`string`	Custom reference field 8 on the license.
`ref9`	`string`	Custom reference field 9 on the license.
`ref10`	`string`	Custom reference field 10 on the license.