# Delete dictionary entry

Delete a dictionary entry by ID. Repeating a deletion returns already_deleted.

POST https://api.brigg.app/v1/operations/meetings.DeleteDictionaryEntry

## Access & visibility

Allow `meetings.DeleteDictionaryEntry` on your API key. Resource read permissions: `core:DictionaryEntry`. Resource write permissions: `core:DictionaryEntry`.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[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 |
| --- | --- | --- | --- |
| `id` | string | Yes | ID of a visible `core:DictionaryEntry` record. Use the relevant list operation to discover records. Use the record's top-level `id`, not a business field or account ID. |
| `expected` | [object](#request-expected) | No | Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource. |

### request.expected

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `phrase` | string or [object](#request-expected-phrase) | No | Commit only if the previous phrase value matches; use $absent to require that this field is missing. |
| `sounds_like` | array of string or [object](#request-expected-sounds-like) | No | Commit only if the previous sounds_like value matches; use $absent to require that this field is missing. |
| `language` | string or [object](#request-expected-language) | No | Commit only if the previous language value matches; use $absent to require that this field is missing. |

### request.expected.phrase

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `$absent` | boolean | Yes | Require the field to be missing, rather than present with a null value. Always `true`. |

### request.expected.sounds_like

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `$absent` | boolean | Yes | Require the field to be missing, rather than present with a null value. Always `true`. |

### request.expected.language

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `$absent` | boolean | Yes | Require the field to be missing, rather than present with a null value. Always `true`. |

## Deletion and retries

A successful response reports whether this call removed the record or it was already absent. Check `cascaded` for dependent record IDs returned by the operation. Retrying the same action uses the original idempotency key. A successful deletion is not an archive you can restore through this operation.

To avoid deleting a record someone has changed, read it first and put the relevant prior business values in `expected`. Keys are relative to `data`, not prefixed with `data.`. Use {"$absent": true} to require a missing field. A mismatch returns 409 conflict; read again and decide whether deletion is still appropriate. A revised action needs a new idempotency key.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `deleted` | string | Yes | deleted when this request removed the record; already_deleted when it was already absent. Allowed: `"deleted"`, `"already_deleted"`. |
| `cascaded` | array of string | No | IDs of dependent records deleted with this record. |

## 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. 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. |
| 409 | `conflict` | A supplied expected value no longer matches. Read the record again before deciding whether to retry. |

## Next steps

- [List dictionary entries](https://developer.brigg.app/reference/meetings/ListDictionaryEntries)
- [Get dictionary entry](https://developer.brigg.app/reference/meetings/GetDictionaryEntry)
- [Create dictionary entry](https://developer.brigg.app/reference/meetings/CreateDictionaryEntry)
- [Upsert dictionary entry](https://developer.brigg.app/reference/meetings/UpsertDictionaryEntry)
- [Update dictionary entry](https://developer.brigg.app/reference/meetings/UpdateDictionaryEntry)

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

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/meetings.DeleteDictionaryEntry' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_dictionaryentry_example"
}'
```

#### TypeScript


```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/meetings.DeleteDictionaryEntry", {
  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({
    "id": "e_dictionaryentry_example"
  }),
});
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 = {
  "id": "e_dictionaryentry_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.DeleteDictionaryEntry",
    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
```

#### Response example


```json
{
  "deleted": "deleted"
}
```

### Delete only if unchanged

Use a value you actually read. A concurrent change refuses the write with 409 conflict.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/meetings.DeleteDictionaryEntry' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_dictionaryentry_example",
  "expected": {
    "phrase": "Northstar"
  }
}'
```

#### TypeScript


```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/meetings.DeleteDictionaryEntry", {
  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({
    "id": "e_dictionaryentry_example",
    "expected": {
      "phrase": "Northstar"
    }
  }),
});
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 = {
  "id": "e_dictionaryentry_example",
  "expected": {
    "phrase": "Northstar"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.DeleteDictionaryEntry",
    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
```

#### Response example


```json
{
  "deleted": "deleted"
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:DictionaryEntry` record. Use the relevant list operation to discover records. Use the record's top-level `id`, not a business field or account ID."
    },
    "expected": {
      "type": "object",
      "description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
      "additionalProperties": false,
      "properties": {
        "phrase": {
          "description": "Commit only if the previous phrase value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Correct spelling of the name or term to recognize."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "sounds_like": {
          "description": "Commit only if the previous sounds_like value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Alternative phonetic spellings used to recognize the phrase in speech."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "language": {
          "description": "Commit only if the previous language value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Recognition language code, for example en for English or no for Norwegian. Omit when the term is not tied to a language. This field is an open string, not a closed enum."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_dictionaryentry_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "deleted": {
      "type": "string",
      "enum": [
        "deleted",
        "already_deleted"
      ],
      "description": "deleted when this request removed the record; already_deleted when it was already absent."
    },
    "cascaded": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of dependent records deleted with this record."
    }
  },
  "required": [
    "deleted"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "deleted": "deleted"
    }
  ]
}
```