Delete conversation — Brigg developers

Access & visibility

Allow support.DeleteConversation on your API key. Resource read permissions: core:Conversation. Resource write permissions: core:Conversation.

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.

idstringRequired

ID of a visible core:Conversation record. Find it with support.ListConversations. Use the record's top-level id, not a business field or account ID.

expectedobjectOptional

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.

Nested fields

inbox_refstring or objectOptional

Commit only if the previous inbox_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

subjectstring or objectOptional

Commit only if the previous subject value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

contact_refstring or objectOptional

Commit only if the previous contact_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

company_refstring or objectOptional

Commit only if the previous company_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

statusstring or objectOptional

Commit only if the previous status value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

assignee_refstring or objectOptional

Commit only if the previous assignee_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

channelstring or objectOptional

Commit only if the previous channel value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

tagsarray of string or objectOptional

Commit only if the previous tags value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

snippetstring or objectOptional

Commit only if the previous snippet value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

last_message_atnumber or objectOptional

Commit only if the previous last_message_at value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

first_response_atnumber or objectOptional

Commit only if the previous first_response_at value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

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.

deletedstringRequired

deleted when this request removed the record; already_deleted when it was already absent.

Allowed: "deleted", "already_deleted".

cascadedarray of stringOptional

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

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:Conversation` record. Find it with [support.ListConversations](/reference/support/ListConversations). 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": {
        "inbox_ref": {
          "description": "Commit only if the previous inbox_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Inbox` record. Find it with [support.ListInboxes](/reference/support/ListInboxes) and use the top-level `id`. This is not an account ID or a display name."
            },
            {
              "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
            }
          ]
        },
        "subject": {
          "description": "Commit only if the previous subject value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Conversation subject shown to the support team."
            },
            {
              "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
            }
          ]
        },
        "contact_ref": {
          "description": "Commit only if the previous contact_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            {
              "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
            }
          ]
        },
        "company_ref": {
          "description": "Commit only if the previous company_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
            },
            {
              "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
            }
          ]
        },
        "status": {
          "description": "Commit only if the previous status value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "new",
                "open",
                "pending",
                "escalated",
                "snoozed",
                "resolved",
                "closed"
              ],
              "description": "Current case state. Resolved and closed are distinct stored states; use the value returned by the API."
            },
            {
              "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
            }
          ]
        },
        "assignee_ref": {
          "description": "Commit only if the previous assignee_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            {
              "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
            }
          ]
        },
        "channel": {
          "description": "Commit only if the previous channel value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "email",
                "web_chat",
                "contact_form",
                "sms",
                "phone"
              ],
              "description": "Channel through which this conversation arrived."
            },
            {
              "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
            }
          ]
        },
        "tags": {
          "description": "Commit only if the previous tags value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
            },
            {
              "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
            }
          ]
        },
        "snippet": {
          "description": "Commit only if the previous snippet value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Short preview of the conversation's latest message."
            },
            {
              "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
            }
          ]
        },
        "last_message_at": {
          "description": "Commit only if the previous last_message_at value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "number",
              "description": "Most recent message time in Unix milliseconds."
            },
            {
              "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
            }
          ]
        },
        "first_response_at": {
          "description": "Commit only if the previous first_response_at value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "number",
              "description": "First response time in Unix milliseconds, when a response has been recorded."
            },
            {
              "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_conversation_example"
    }
  ]
}

Full response JSON schema

{
  "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"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

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

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.DeleteConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_conversation_example"
}'

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/support.DeleteConversation", {
  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_conversation_example"
  }),
});
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 = {
  "id": "e_conversation_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.DeleteConversation",
    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/support.DeleteConversation' \
  -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 '{
  "id": "e_conversation_example"
}'

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

{
  "deleted": "deleted"
}

Illustrative values, not a live response.

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

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.DeleteConversation' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_conversation_example",
  "expected": {
    "inbox_ref": "e_inbox_support"
  }
}'

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/support.DeleteConversation", {
  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_conversation_example",
    "expected": {
      "inbox_ref": "e_inbox_support"
    }
  }),
});
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 = {
  "id": "e_conversation_example",
  "expected": {
    "inbox_ref": "e_inbox_support"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.DeleteConversation",
    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/support.DeleteConversation' \
  -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 '{
  "id": "e_conversation_example",
  "expected": {
    "inbox_ref": "e_inbox_support"
  }
}'

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/support.DeleteConversation", {
  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({
    "id": "e_conversation_example",
    "expected": {
      "inbox_ref": "e_inbox_support"
    }
  }),
});
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 = {
  "id": "e_conversation_example",
  "expected": {
    "inbox_ref": "e_inbox_support"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.DeleteConversation",
    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

{
  "deleted": "deleted"
}

Illustrative values, not a live response.