GEgetsales
sender_profiles

Update a sender profile mailbox

Edit one mailbox of the sender profile. display_name, signature_html, sending_limits, warmup_config, tracking and email_tracking_domain_sid are pushed to gtm and mirrored back; bcc, history_since, history_scope and is_primary stay local. A refusal of gtm's names its cause in error.context.reason (403 gtm_scope_missing, 409 mailbox_gone, 429 gtm_busy, 503 gtm_unavailable) or the field rule (422 tracking_domain_not_verified). LinkedIn limits: update_sender_profile_linkedin_limit.

Contract:

  • MCP tool update_sender_profile_mailbox, registry package mcp.unibox/sender_profiles, mount unibox.sender-profile-mailboxes.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/sender-profiles/{sid}/mailboxes/{emailAccountSid}

Request

  • Base URL
    https://beta.getsales.io/unibox/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Sender profile sid (ub_sp_…).

emailAccountSidstring required

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

Request body

display_namestring nullable

The From name gtm sends under.

signature_htmlstring nullable

HTML signature gtm appends on send; null removes it.

track_opensboolean

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

track_clicksboolean

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

email_tracking_domain_sidstring nullable

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

bccstring[] nullable

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.

history_sincestring nullable

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.

history_scope'all' | 'playtable_people' nullable

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.

is_primarytrue

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.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

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

Changes

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