Skip to content

publish_resource_hub_document

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/publish_resource_hub_document
HandlerOperatelyWeb.Api.Mutations.PublishResourceHubDocument

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
document_idid primitive (encoded as string)YesNo-
namestringNoYes-
contentjson primitive (encoded as string)NoYes-
send_notifications_to_everyonebooleanNoYes-
subscriber_idsarray of id primitive (encoded as string)NoYes-

Outputs#

FieldTypeRequiredNullable
documentresource_hub_document objectNoYes

cURL Example#

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

Response Example#

{
  "document": {
    "author": "<person>",
    "comments_count": 123,
    "content": "value",
    "id": "value",
    "inserted_at": "value",
    "name": "value",
    "notifications": [
      "<notification>"
    ],
    "parent_folder": "<resource_hub_folder>",
    "parent_folder_id": "value",
    "path_to_document": [
      "<resource_hub_folder>"
    ],
    "permissions": "<resource_hub_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "reactions": [
      "<reaction>"
    ],
    "resource_hub": "<resource_hub>",
    "resource_hub_id": "value",
    "state": "value",
    "subscription_list": "<subscription_list>",
    "updated_at": "2026-01-01"
  }
}