# Delete content

Permanently delete content identified by content_id. Requires authority to administer it; an active signing request prevents deletion. Reports retained fields whose values belong to records outside the deleted app.

POST https://api.brigg.app/v1/operations/documents.DeleteBundle

## Access & visibility

Allow `documents.DeleteBundle` on your API key.

**Acting member required.** Send `Brigg-Act-As` with an [approved member account ID](https://developer.brigg.app/authentication#member-delegation). The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `content_id` | string | Yes | Use content_id and check kind before choosing the operation. An app, template, website and uploaded file are not interchangeable. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles). At least 1 character. |

## Check the content before permanent deletion

Select content_id and inspect kind in [List content](https://developer.brigg.app/reference/workspace/ListBundles). This deletes the selected app, template, website or generated content and its associated artifacts. It is not the operation for deleting one customer record or an uploaded file; use the appropriate record operation or [Delete document](https://developer.brigg.app/reference/documents/DeleteDocument). There is no public undo.

The acting member needs workspace access and must own the content, have created it, or be a workspace owner or administrator. Workspace-managed material such as shared newsletters also permits workspace members; an ordinary shared app is not automatically administrable by every reader. A signing lock protects both a pending document and a completed signed record. Inspect signing state before attempting deletion.

For apps, fields added to another resource type can survive when records outside this app still use them. retained_fields reports those definitions; an empty array means none needed retaining. A fresh deletion of an absent content_id returns app_not_found; retrying the original action with the same idempotency key can replay the original result.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ok` | boolean | Yes | Whether the action completed successfully. |
| `retained_fields` | array of [DeleteBundleRetainedExtensionFields](#deletebundleretainedextensionfields-response-retained-fields) | Yes | Field definitions retained because values still belong to records outside the deleted content. |

### DeleteBundleRetainedExtensionFields · response.retained_fields[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `target_type` | string | Yes | Resource type owned by another app whose records still contain values in fields added by the deleted app. |
| `fields` | array of string | Yes | Names of extension fields retained on that resource type to preserve surviving record values. These are field keys, not template instructions or attachments. |

## 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](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| 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. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 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. |
| 409 | `signing_locked` | A signing request protects this document from this change. Inspect its signing state in Brigg; completed signed records must not be destroyed. |
| 404 | `app_not_found` | This content does not exist or is not visible. A fresh delete after successful removal also returns this code. |

## Next steps

- [List bundles](https://developer.brigg.app/reference/workspace/ListBundles)
- [Delete document](https://developer.brigg.app/reference/documents/DeleteDocument)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Delete selected content

This fictional app added a field to Company records. Their existing values survive the app deletion.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/documents.DeleteBundle' \
  -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 '{
  "content_id": "c_vendor_portal"
}'
```

#### TypeScript


```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.DeleteBundle", {
  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({
    "content_id": "c_vendor_portal"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```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 = {
  "content_id": "c_vendor_portal"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.DeleteBundle",
    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
```

#### Response example


```json
{
  "ok": true,
  "retained_fields": [
    {
      "target_type": "core:Company",
      "fields": [
        "vendor_portal_code"
      ]
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "content_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use content_id and check kind before choosing the operation. An app, template, website and uploaded file are not interchangeable. [workspace.ListBundles](https://developer.brigg.app/reference/workspace/ListBundles)."
    }
  },
  "required": [
    "content_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "content_id": "c_vendor_portal"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    },
    "retained_fields": {
      "type": "array",
      "items": {
        "title": "DeleteBundleRetainedExtensionFields",
        "type": "object",
        "properties": {
          "target_type": {
            "type": "string",
            "description": "Resource type owned by another app whose records still contain values in fields added by the deleted app."
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Names of extension fields retained on that resource type to preserve surviving record values. These are field keys, not template instructions or attachments."
          }
        },
        "required": [
          "target_type",
          "fields"
        ],
        "additionalProperties": false
      },
      "description": "Field definitions retained because values still belong to records outside the deleted content."
    }
  },
  "required": [
    "ok",
    "retained_fields"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "ok": true,
      "retained_fields": [
        {
          "target_type": "core:Company",
          "fields": [
            "vendor_portal_code"
          ]
        }
      ]
    }
  ]
}
```