Skip to content

edit_resource_hub_file

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/edit_resource_hub_file
HandlerOperatelyWeb.Api.Mutations.EditResourceHubFile

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
file_idid primitive (encoded as string)NoYes-
namestringNoYes-
descriptionstringNoYes-

Outputs#

FieldTypeRequiredNullable
fileresource_hub_file objectNoYes

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/edit_resource_hub_file" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"description":"value", "file_id":"value", "name":"value"}'

Response Example#

{
  "file": {
    "author": "<person>",
    "blob": "<blob>",
    "comments_count": 123,
    "description": "value",
    "id": "value",
    "inserted_at": "value",
    "name": "value",
    "parent_folder": "<resource_hub_folder>",
    "parent_folder_id": "value",
    "path_to_file": [
      "<resource_hub_folder>"
    ],
    "permissions": "<resource_hub_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "reactions": [
      "<reaction>"
    ],
    "resource_hub": "<resource_hub>",
    "resource_hub_id": "value",
    "size": 123,
    "subscription_list": "<subscription_list>",
    "type": "value"
  }
}