create_resource_hub_link

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/create_resource_hub_link
Handler	OperatelyWeb.Api.Mutations.CreateResourceHubLink

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
resource_hub_id	id primitive (encoded as string)	No	Yes	-
folder_id	id primitive (encoded as string)	No	Yes	-
name	string	No	Yes	-
url	string	No	Yes	-
description	string	No	Yes	-
type	string	No	Yes	-
send_notifications_to_everyone	boolean	No	Yes	-
subscriber_ids	array of id primitive (encoded as string)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
link	resource_hub_link object	No	Yes

cURL Example#

Copied

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

Response Example#

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