GEgetsales
sender_profiles

Start a mailbox connect for a sender profile

Start connecting a new Google or Microsoft mailbox to this sender profile: the consent runs on gtm's hosted page and the connected delivery attaches the mailbox here, not to a new sender profile. The intent lives 24 hours, matches on the provider and keeps history_since and history_scope, so run one at a time per provider. Typed IMAP / SMTP credentials: connect_sender_profile_imap_mailbox; a mailbox gtm already holds: attach_sender_profile_mailbox.

Contract:

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

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

provider'google' | 'microsoft' required

Required. Only the two OAuth providers land on a sender profile this way; for IMAP / SMTP credentials use connect_sender_profile_imap_mailbox.

success_redirect_urlstring uri nullable

Where gtm sends the human after the consent. gtm follows it only for allow-listed hosts.

display_namestring nullable

The From name to give the mailbox once it lands on the sender profile.

history_sincestring nullable

The mailbox's history window: import its mail from this day (YYYY-MM-DD) on, or none of the past with now (only what arrives once the mailbox lands); omitted or null = all of it. The intent keeps it until the mailbox lands.

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 intent keeps it until the mailbox lands.

Response

action success envelope.

successtrue required
operation'action' required
actionstring required

kebab-case verb; matches the route segment.

itemobject nullable required

Changes

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