PUT /api/v1/customuserlinks
Update the user attributes of a custom link.
Query body
| Name | Type | Mandatory | Notes |
|---|---|---|---|
type | String | Yes | Current internal name of the link. Must correspond to the type of an existing custom link. |
mail | String | Yes | Email address of the user. |
update / url | String | No | Target URL of the link, for that user. |
update / type | String | No | New internal name of the link. Must correspond to the type of an existing custom link. |
Return an error if type or update / 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 |
|---|---|---|---|
type |
String | No | |
update |
Object | No | |
update.url |
String | No | |
update.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.