Add inbox support address — Brigg developers

Access & visibility

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

addressstringRequired

Public support email address that you have configured to forward into this inbox. Adding sends a verification email; it does not configure your email provider.

At least 3 characters. At most 254 characters.

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 verified_at. 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.

addressobjectRequired

Street address, including building or unit when applicable.

Nested fields

idstringRequired

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

addressstringRequired

Normalized additional public support email address, distinct from Brigg's generated inbox-forwarding address.

created_atnumberRequired

Unix millisecond timestamp when this address was added.

verified_atnumber or nullRequired

Unix millisecond time a valid test returned through this inbox, or null while unverified.

test_sent_atnumber or nullRequired

Unix millisecond time the newest test was sent, or null if no test has been sent. This does not prove verification.

teststringRequired

sent means a test email was sent; already_verified sends nothing; rate_limited means wait before requesting another test; send_failed means delivery could not be initiated. Read verified_at to confirm forwarding verification.

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	`invalid_address`	Supply a single valid public support email address.
400	`too_many`	The inbox already has the supported twenty additional addresses. Review existing entries before removing any.
409	`org_not_provisioned`	This workspace has no inbox-forwarding configuration yet. Finish inbox setup in Brigg.

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)."
    },
    "address": {
      "type": "string",
      "minLength": 3,
      "maxLength": 254,
      "description": "Public support email address that you have configured to forward into this inbox. Adding sends a verification email; it does not configure your email provider."
    }
  },
  "required": [
    "inbox_id",
    "address"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "inbox_id": "e_inbox_support",
      "address": "help@example.com"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "address": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Additional address id from ListInboxSupportAddresses.items for this same inbox_id. It is not the email address, inbox ID, or a verification token."
        },
        "address": {
          "type": "string",
          "description": "Normalized additional public support email address, distinct from Brigg's generated inbox-forwarding address."
        },
        "created_at": {
          "type": "number",
          "description": "Unix millisecond timestamp when this address was added."
        },
        "verified_at": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix millisecond time a valid test returned through this inbox, or null while unverified."
        },
        "test_sent_at": {
          "type": [
            "number",
            "null"
          ],
          "description": "Unix millisecond time the newest test was sent, or null if no test has been sent. This does not prove verification."
        }
      },
      "required": [
        "id",
        "address",
        "created_at",
        "verified_at",
        "test_sent_at"
      ],
      "additionalProperties": false,
      "description": "Street address, including building or unit when applicable."
    },
    "test": {
      "type": "string",
      "description": "sent means a test email was sent; already_verified sends nothing; rate_limited means wait before requesting another test; send_failed means delivery could not be initiated. Read verified_at to confirm forwarding verification."
    }
  },
  "required": [
    "address",
    "test"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "address": {
        "id": "isa_help",
        "address": "help@example.com",
        "created_at": 1794301200000,
        "verified_at": null,
        "test_sent_at": 1794301200000
      },
      "test": "sent"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Store address.id and poll ListInboxSupportAddresses for verified_at.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.AddInboxSupportAddress' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "inbox_id": "e_inbox_support",
  "address": "help@example.com"
}'

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.AddInboxSupportAddress", {
  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",
    "address": "help@example.com"
  }),
});
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",
  "address": "help@example.com"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.AddInboxSupportAddress",
    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.AddInboxSupportAddress' \
  -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",
  "address": "help@example.com"
}'

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.AddInboxSupportAddress", {
  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",
    "address": "help@example.com"
  }),
});
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",
  "address": "help@example.com"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.AddInboxSupportAddress",
    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

{
  "address": {
    "id": "isa_help",
    "address": "help@example.com",
    "created_at": 1794301200000,
    "verified_at": null,
    "test_sent_at": 1794301200000
  },
  "test": "sent"
}

Illustrative values, not a live response.

Keep the address ID; retry the test later rather than creating another address.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.AddInboxSupportAddress' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "inbox_id": "e_inbox_support",
  "address": "help@example.com"
}'

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.AddInboxSupportAddress", {
  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",
    "address": "help@example.com"
  }),
});
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",
  "address": "help@example.com"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.AddInboxSupportAddress",
    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.AddInboxSupportAddress' \
  -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",
  "address": "help@example.com"
}'

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.AddInboxSupportAddress", {
  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",
    "address": "help@example.com"
  }),
});
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",
  "address": "help@example.com"
}
request = Request(
    "https://api.brigg.app/v1/operations/support.AddInboxSupportAddress",
    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

{
  "address": {
    "id": "isa_help",
    "address": "help@example.com",
    "created_at": 1794301200000,
    "verified_at": null,
    "test_sent_at": null
  },
  "test": "rate_limited"
}

Illustrative values, not a live response.