Endpoint#
| Property | Value |
|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/delete_space |
| Handler | OperatelyWeb.Api.Mutations.DeleteSpace |
Authentication#
- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|
space_id | id primitive (encoded as string) | Yes | No | - |
Outputs#
| Field | Type | Required | Nullable |
|---|
space | space object | Yes | No |
cURL Example#
Copiedcurl --request POST \
--url "https://app.operately.com/api/external/v1/delete_space" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"space_id":"value"}'
Response Example#
{
"space": {
"access_levels": "<access_levels>",
"color": "value",
"icon": "value",
"id": "value",
"is_company_space": true,
"is_member": true,
"members": [
"<person>"
],
"mission": "value",
"name": "value",
"notifications": [
"<notification>"
],
"permissions": "<space_permissions>",
"potential_subscribers": [
"<subscriber>"
],
"private_space": true,
"task_statuses": [
"<task_status>"
],
"tasks_kanban_state": "value"
}
}