Sign in
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

Changes

Changed in 1 of the 3 revisions of this API.6

  • 5a5597ebb2d66See the full diff
    • ○

      added the optional property retry_after to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retry_after to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property retryable to the response with the 404 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog