Remove inbox support address — Brigg developers

Access & visibility

Allow support.RemoveInboxSupportAddress 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.

inbox_idstringRequired

Use the support inbox record's top-level id, not its slug or forwarding address. support.ListInboxes.

At least 1 character.

idstringRequired

Additional address id from ListInboxSupportAddresses.items for this same inbox_id. It is not the email address, inbox ID, or a verification token.

At least 1 character.

Verify forwarding before using a support address

Get the inbox_id and forwarding address from List inbox channels. Configure your mail provider to forward the public support address into that inbox, then add the address. Adding it sends a verification email; the address becomes verified only when that email is forwarded back into the correct Brigg inbox.

List support addresses to check verifiedAt. A test=sent response only confirms a send attempt; it is not verification. Only the newest test can verify, and it expires after 24 hours. Fix forwarding before requesting another test. Verification permits that address to be used as Reply-To for its conversations; it does not change the authenticated sender.

Removing the address withdraws its verified Reply-To use. It does not remove your mail provider's forwarding rule or delete the inbox and its conversations. Change provider forwarding separately when retiring the address.

Response

Returns 200 OK with a JSON body.

okbooleanRequired

Whether the action completed successfully.

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 inbox or the additional-address ID is absent. Re-list that inbox's support addresses; do not substitute an email string or a different inbox's ID.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "inbox_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use the support inbox record's top-level id, not its slug or forwarding address. [support.ListInboxes](/reference/support/ListInboxes)."
    },
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "Additional address id from ListInboxSupportAddresses.items for this same inbox_id. It is not the email address, inbox ID, or a verification token."
    }
  },
  "required": [
    "inbox_id",
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "inbox_id": "e_inbox_support",
      "id": "isa_help"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the action completed successfully."
    }
  },
  "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.

The inbox and its other addresses remain; provider forwarding is managed separately.

Request

cURL

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

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

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