senders

Update a mailbox

A mailbox's own settings: its daily send limit and which sender it sends as. Name and signature live on the sender.

patch/mailboxes/{mailbox_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/mailboxes/{mailbox_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

mailbox_idstring uuid required

Request body

Response

Successful Response

bounce_ratenumber nullable

DSNs / accepted sends, lifetime.

connection_status'connected' | 'disconnected' required

Whether the mailbox's grant currently authenticates.

created_atstring date-time required
daily_send_limitinteger required
disconnected_atstring date-time nullable required
disconnected_reasonstring nullable required
email_addressstring required
idstring uuid required
last_verified_atstring date-time nullable

When the grant last passed its check.

provider'google_workspace' | 'google_workspace_dwd' required

Which email provider a mailbox connects through.

Only Google Workspace ships so far; every provider is implemented behind providers.EmailProviderBase so Office 365 and IMAP/SMTP can be added later without touching callers.

GOOGLE_WORKSPACE holds a per-mailbox OAuth grant (consent screen, refresh token). GOOGLE_WORKSPACE_DWD holds no grant at all: tokens are minted on demand via domain-wide delegation as the platform service account, so its rows carry an empty refresh_token forever. It is the path imported fleets (e.g. InboxKit) connect through.

reply_ratenumber nullable

Genuine replies / accepted sends, lifetime.

sender_profile_idstring uuid nullable required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.