POST /api/v1/customuserlinks
Display a custom link in the right sidebar of a user, in the homepage. Must be used after createCustomLink.
Query body
| Name | Type | Mandatory | Notes |
|---|---|---|---|
mail | String | Yes | Email of the user in whose profile the link should be displayed. |
url | String | Yes | Target URL of the link, for that user. |
type | String | Yes (unique) | Internal name of the link. Must correspond to the type of an existing custom link. |
Return an error if type doesn’t correspond to any custom link, or if mail doesn’t correspond to an existing user in the platform.
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 |
|---|---|---|---|
url |
String | No | |
type |
String | No | |
mail |
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.