Endpoint#
| Property | Value |
|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/publish_resource_hub_document |
| Handler | OperatelyWeb.Api.Mutations.PublishResourceHubDocument |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|
document_id | id primitive (encoded as string) | Yes | No | - |
name | string | No | Yes | - |
content | json primitive (encoded as 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 |
|---|
document | resource_hub_document object | No | Yes |
cURL Example#
Copiedcurl --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"
}
}