Delete folder — Brigg developers

Access & visibility

Allow documents.DeleteFolder on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

scopestringRequired

Collection: org is workspace-shared, user belongs to the approved acting member, and resources contains shared, predefined resource roots. Use ListDocuments with the same scope to discover existing paths.

Allowed: "org", "user", "resources".

pathstringRequired

Nonempty path within the selected collection, such as Projects/Archive. Use slash-separated names, not a file ID or a URL. Leading/trailing and repeated slashes are normalized; dot segments are refused. Use the returned/listed path for later calls.

At least 1 character. At most 1024 characters.

Remove the folder, not its contents

Use List documents with the same scope and path first. Both items and folders must be empty. Move documents elsewhere and remove child folders deliberately; this operation never recursively deletes their content.

The collection root, predefined resources roots and workspace roots reserved by an installed app cannot be deleted. A missing empty folder succeeds. The path is a location within the collection, not a file ID.

Response

Returns 200 OK with a JSON body.

okbooleanRequired

True when the selected folder is absent after the call. An already absent empty folder also succeeds.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
400	`not_empty`	The folder contains documents or child folders. List its contents and move or remove them deliberately before deleting the folder.
400	`reserved_root`	An installed app owns this workspace root. Its contents can be edited, but the root cannot be deleted.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "enum": [
        "org",
        "user",
        "resources"
      ],
      "description": "Collection: org is workspace-shared, user belongs to the approved acting member, and resources contains shared, predefined resource roots. Use ListDocuments with the same scope to discover existing paths."
    },
    "path": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1024,
      "description": "Nonempty path within the selected collection, such as Projects/Archive. Use slash-separated names, not a file ID or a URL. Leading/trailing and repeated slashes are normalized; dot segments are refused. Use the returned/listed path for later calls."
    }
  },
  "required": [
    "scope",
    "path"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "scope": "org",
      "path": "Projects/Archive"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "True when the selected folder is absent after the call. An already absent empty folder also succeeds."
    }
  },
  "required": [
    "ok"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Inspect the exact folder before removing it.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.DeleteFolder' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "scope": "org",
  "path": "Projects/Archive"
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/documents.DeleteFolder", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "scope": "org",
    "path": "Projects/Archive"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "scope": "org",
  "path": "Projects/Archive"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.DeleteFolder",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/documents.DeleteFolder' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "scope": "org",
  "path": "Projects/Archive"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/documents.DeleteFolder", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "scope": "org",
    "path": "Projects/Archive"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "scope": "org",
  "path": "Projects/Archive"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.DeleteFolder",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "ok": true
}

Illustrative values, not a live response.