Endpoint#
| Property | Value |
|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/folders/create |
| Handler | OperatelyWeb.Api.Folders.Create |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|
resource_hub_id | id primitive (encoded as string) | Yes | No | - |
folder_id | id primitive (encoded as string) | No | Yes | - |
name | string | Yes | No | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
folder | resource_hub_folder object | Yes | No |
cURL Example#
Copiedcurl --request POST \
--url "https://app.operately.com/api/external/v1/folders/create" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"folder_id":"value", "name":"value", "resource_hub_id":"value"}'
Response Example#
{
"folder": {
"children_count": 123,
"description": "value",
"id": "value",
"name": "value",
"nodes": [
"<resource_hub_node>"
],
"parent_folder_id": "value",
"path_to_folder": [
"<resource_hub_folder>"
],
"permissions": "<resource_hub_permissions>",
"potential_subscribers": [
"<subscriber>"
],
"resource_hub": "<resource_hub>",
"resource_hub_id": "value"
}
}