Documents API: Create link

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/documents/create_link
Handler	OperatelyWeb.Api.Wrappers.DocsAndFiles.CreateLink

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
space_id	id primitive (encoded as string)	No	Yes	-
project_id	id primitive (encoded as string)	No	Yes	-
goal_id	id primitive (encoded as string)	No	Yes	-
folder_id	id primitive (encoded as string)	No	Yes	-
name	string	Yes	No	-
url	string	Yes	No	-
description	json primitive (encoded as string)	No	No	-
type	resource_hub_link_type enum (airtable, dropbox, figma, google, google_doc, google_sheet, google_slides, notion, other)	Yes	No	-
send_notifications_to_everyone	boolean	No	No	true
subscriber_ids	array of id primitive (encoded as string)	No	No	[]

Outputs#

Field	Type	Required	Nullable
link	resource_hub_link object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/documents/create_link" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"description":"value", "folder_id":"value", "goal_id":"value", "name":"value", "project_id":"value", "send_notifications_to_everyone":true, "space_id":"value", "subscriber_ids":["value"], "type":"airtable", "url":"value"}'

Response Example#

{
  "link": {
    "__typename": "value",
    "author": "<person>",
    "comments_count": 123,
    "description": "value",
    "goal": "<goal>",
    "id": "value",
    "inserted_at": "value",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "page_url": "value",
    "parent_folder": "<resource_hub_folder>",
    "parent_folder_id": "value",
    "path_to_link": [
      "<resource_hub_folder>"
    ],
    "permissions": "<resource_hub_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "project": "<project>",
    "reactions": [
      "<reaction>"
    ],
    "resource_hub": "<resource_hub>",
    "resource_hub_id": "value",
    "space": "<space>",
    "subscription_list": "<subscription_list>",
    "type": "airtable",
    "url": "value"
  }
}