Skip to main content
PATCH
Update email account

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Headers

Email-Box-SID
string

Email server (em_bx_...) the call is for, from search_email_boxes. Omitted: the primary server.

Pattern: ^em_bx_[A-Za-z0-9]{12}$

Path Parameters

sid
string
required

Path segment {sid}.

Required string length: 18
Pattern: ^em_ac_

Body

application/json

Request body of update_email_account.

display_name
string | null
Maximum string length: 255
label
string | null

null or an empty string clears it.

Maximum string length: 64
signature_html
string | null
Maximum string length: 8192
sending_limits
object
warmup_config
object
track_opens
boolean
track_clicks
boolean
email_tracking_domain_sid
string | null

A verified tracking domain; null unbinds it.

Required string length: 18
Pattern: ^em_td_
sync_config
object

Sync cadence per track: keys messages, folders, health_check, each { interval_minutes }, 5 or more. A key left out uses the service default.

webhook_config
object

Which event families this mailbox emits: keys email-messages, email-threads, email-engagements, email-accounts, email-account-health, each { enabled }. A key left out is off.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required