Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Custom Links

Replace a custom link

🔑

Required OAuth scope: customLinks:write.

Replaces the custom link with the provided data. Fields not included in the payload are removed.

put/api/v2/custom-links/{customLinkId}

Path parameters

customLinkIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the custom link.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

namestring required

The title displayed on the custom link.

orderinteger required

The numeric display order (ascending). Links are arranged horizontally from left to right and wrap to the next line as needed.

typestring required

The unique identifier associated to your custom link. This information is not displayed to learners on the platform.

iconName'agenda' | 'absence' | 'certificate' | 'convention' | 'default' | 'inbox' | 'survey'

The type of icon used on the custom link. By default, the link icon will be used.

Example request

{
  "name": "Portal managers",
  "order": 3,
  "type": "Manager Link FR",
  "iconName": "inbox"
}

Response

Returns the updated custom link.

namestring required

The title displayed on the custom link.

orderinteger required

The numeric display order (ascending). Links are arranged horizontally from left to right and wrap to the next line as needed.

typestring required

The unique identifier associated to your custom link. This information is not displayed to learners on the platform.

iconName'agenda' | 'absence' | 'certificate' | 'convention' | 'default' | 'inbox' | 'survey'

The type of icon used on the custom link. By default, the link icon will be used.

_idstring ObjectId required

The ID of the custom link.

Example response

{
  "name": "Portal managers",
  "order": 3,
  "type": "Manager Link FR",
  "iconName": "inbox",
  "_id": "507f1f77bcf86cd799439011"
}