Skip to main content
PATCH
Update a sender profile mailbox

Authorizations

Authorization
string
header
required

Access token issued by gs.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.

Path Parameters

sid
string
required

Sender profile sid (ub_sp_…).

Required string length: 18
Pattern: ^ub_sp_
emailAccountSid
string
required

Which mailbox of the sender profile to edit (em_ac_…); a sid the sender profile does not hold is a 404.

Required string length: 18
Pattern: ^em_ac_

Body

application/json

Request body of update_sender_profile_mailbox.

display_name
string | null

The From name gtm sends under.

Maximum string length: 255
signature_html
string | null

HTML signature gtm appends on send; null removes it.

Maximum string length: 8192
sending_limits
object

Pushed to gtm, which enforces it at the next send. Keys left out keep their current value. The ranges are gtm's own.

warmup_config
object

The gtm warm-up ramp for a fresh mailbox. While it runs, gtm sends at most the smaller of the daily limit and the ramp.

track_opens
boolean

Open tracking through the pixel the tracking domain serves, so it needs one set.

track_clicks
boolean

Link tracking rewrites the URLs through the tracking domain, so it needs one set.

email_tracking_domain_sid
string | null

The gtm tracking domain that serves the open pixel and the click links; null = none.

Required string length: 18
Pattern: ^em_td_
bcc
string<email>[] | null

Standing blind copies for every send from this mailbox, at most 5. LOCAL to the sender profile: gtm never sees them. null clears the list.

Maximum array length: 5
Maximum string length: 320
history_since
string | null

The mailbox's history window, LOCAL to the sender profile; present with null = all history, now = from this change on. An earlier day, or null, re-walks this mailbox down to it (the people's activity too); a later day, or now, deletes nothing.

Pattern: ^(now|\d{4}-\d{2}-\d{2})$
history_scope
enum<string> | null

The mailbox's import scope, LOCAL to the sender profile; present with null = playtable_people, the default. Back to all re-walks this mailbox so the threads the people-only scope kept out come in; playtable_people deletes nothing.

Available options:
all,
playtable_people
is_primary
enum<boolean>

Make this mailbox the sender profile's primary: the one email_account_sid points at, the composer's default. The others lose the flag; gtm is not asked. Only true: a mailbox gives the role up when another one takes it.

Available options:
true

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
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.