PUT /api/v1/customlinks

Update a custom link.

Query body

NameTypeMandatoryNotes
typeStringYesCurrent internal name of the link.
update / iconNameStringNoCan be used to display a specific icon. Default value is default. Other possible values are: agenda, absence, certificate, convention, survey and inbox
update / nameStringNoName of the button. Will be visible to users.
update / orderPositive integer [0;∞[Yes (unique)Determines the position of the link (0 is first).
update / typeStringNoNew internal name of the link. Will be used to display the link in a user sidebar.

Servers

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.order Number No
update.name String No
update.iconName String No
update.type String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.