Skip to main content
PATCH
/
v1
/
email
/
accounts
/
{account_id}
Update mutable mailbox settings (e.g., default signature)
curl --request PATCH \
  --url https://api-sandbox.featherhq.com/v1/email/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "default_signature_html": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "<string>",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_account_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "capabilities": [
    "<string>"
  ],
  "default_signature_html": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
account_id
string<uuid>
required

Body

application/json

Partial update for a connected mailbox.

Mutable today: the per-account default signature (ENG-417) and the agent/team binding (rebind without re-running OAuth). Future fields (e.g., display name overrides) slot in here without a new endpoint.

The binding is updated only when agent_id or team_id is present in the request body (model_fields_set sentinel). At most one may be set per request — a mailbox binds to either a single agent or a team. Explicit None on a present key clears that side of the binding.

​
default_signature_html
string | null
Maximum string length: 20000
​
agent_id
string<uuid> | null
​
agent_revision_id
string<uuid> | null
​
team_id
string<uuid> | null
​
team_revision_id
string<uuid> | null

Response

Successful Response

One row in the org's connected-mailbox list.

​
id
string<uuid>
required
​
address
string
required
​
provider
enum<string>
required

Mailbox-native providers we connect to via Nylas in v1.

Both providers ride the same MailboxConnector (Nylas implementation). Pattern B (brand-domain transactional sending: SendGrid / SES / Resend) is v2 and lives in a separate connector.

Available options:
gmail,
microsoft
​
status
enum<string>
required
Available options:
pending,
active,
paused,
error,
needs_reauth,
retired
​
agent_id
string<uuid> | null
required
​
external_account_id
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
agent_revision_id
string<uuid> | null
​
team_id
string<uuid> | null
​
team_revision_id
string<uuid> | null
​
capabilities
string[]
​
default_signature_html
string | null