Skip to main content

Create a link

Create a link.

Parameters​

title
string
required
Title of the link.
description
string
Description of the link.
url
string
required
URL of the link.
visibility
enum
required
Visibility of the link. One of private, internal, shared.
role
enum
Only when visibility is internal. Used as the default role for all team members. If a user has a directly attached role, it will override this one. One of link_admin, link_manager, link_viewer.
folder
string
Unique identifier for the folder in which the link will be created.

Returns​

Returns the created link object. Throws an error if some parameters are not valid.

post
/api/links
curl -X POST https://{workspace}.kitchen.co/api/links \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'X-Requested-With: XMLHttpRequest' \
    -H 'Authorization: Bearer {API_KEY}'
Response
{
  "archived_at": null,
  "created_at": "2024-03-12T12:54:41+00:00",
  "id": "pe_12b3c33d7f42bcbd1b373ff9",
  "title": "The link title",
  "description": null,
  "updated_at": "2024-03-12T12:54:41+00:00",
  "url": "https://example.com",
  "visibility": "internal"
}