POST /api/v1/customlinks
Create a custom link at the platform level. Use createCustomUserLink to display it in a user’s side panel in the homepage.
Query body
| Name | Type | Mandatory | Notes |
|---|---|---|---|
name | String | Yes (unique) | Name of the button. Will be visible to users. |
order | Positive integer [0;∞[ | Yes (unique) | Determines the position of the link (0 is first). |
type | String | Yes (unique) | Internal name of the link. Will be used to display the link in a user sidebar. |
iconName | String | No | Can be used to display a specific icon. Default value is default. Other possible values are: agenda, absence, certificate, convention, survey and inbox |
Return an error if name, order or type already exists.
Servers
- https://app.360learning.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
order |
Number | No | |
name |
String | No | |
iconName |
String | No | |
type |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.