sender_profiles

Attach a mailbox to a sender profile

Bind a mailbox gtm already holds (a free row of list_sender_profile_available_accounts with channel email) to this sender profile; the first mailbox becomes the primary, the one email_account_sid points at. 404 on a mailbox no workspace holds, 409 when another sender profile holds it. Idempotent. history_since and history_scope bound what of its mail reaches the inbox. A sender profile may hold several mailboxes; an email step rotates across the active ones.

Contract:

  • MCP tool attach_sender_profile_mailbox, registry package mcp.unibox/sender_profiles, mount unibox.sender-profile-mailboxes.
  • Operation action, response envelope action.
  • Flags: none.
post/api/sender-profiles/{sid}/mailboxes/attach

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_…).

Request body

email_account_sidstring required

A mailbox gtm already holds (a row of list_sender_profile_available_accounts with channel:email whose sender_profile_sid is null).

connection_sidstring nullable

The gtm workspace the picker row came from. Omitted, the team's connections are tried in order, the managed one first.

history_sincestring nullable

The mailbox's history window: import its mail from this day (YYYY-MM-DD) on, or nothing older than the attach with now; omitted or null = all of it.

history_scope'all' | 'playtable_people' nullable

The mailbox's import scope: playtable_people (omitted or null, the default) takes only the threads with a person the workspace keeps in a playtable, all every thread; the walk that starts on attach obeys it.

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

Changes

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