Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-304917042.1 MB
email

Update mutable mailbox settings (e.g., default signature)

Partial-update endpoint. Only fields present in the request body are applied — omitted keys leave the row unchanged. Explicit null on default_signature_html clears the signature.

Rebind path: when agent_id or team_id is present in the body, the mailbox binding is updated in place (no OAuth re-run). At most one of the two may be set (the schema validator enforces it); an explicit null on a present key clears that side of the binding.

patch/v1/email/accounts/{account_id}

Path parameters

account_idstring uuid required

Request body

default_signature_htmlstring nullable
agent_idstring uuid nullable
agent_revision_idstring uuid nullable
team_idstring uuid nullable
team_revision_idstring uuid nullable

Response

Successful Response

idstring uuid required
addressstring required
provider'gmail' | 'microsoft' 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.

status'pending' | 'active' | 'paused' | 'error' | 'needs_reauth' | 'retired' required
agent_idstring uuid nullable required
agent_revision_idstring uuid nullable
team_idstring uuid nullable
team_revision_idstring uuid nullable
external_account_idstring nullable required
capabilitiesstring[]
default_signature_htmlstring nullable
created_atstring date-time required
updated_atstring date-time required