GEgetsales
sender_profiles

Connect an IMAP mailbox to a sender profile

Create an IMAP / SMTP mailbox on gtm from typed credentials and attach it to this sender profile. Both passwords ride through to gtm, which stores them; nothing of them is kept or readable here. backfill_days is how much existing mail gtm pulls at connect; history_since and history_scope bound what of it reaches the inbox. For Google or Microsoft use start_sender_profile_mailbox_connect; for a mailbox gtm already holds, attach_sender_profile_mailbox.

Contract:

  • MCP tool connect_sender_profile_imap_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/connect-imap

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

addressstring email required

The mailbox address to create on gtm.

display_namestring nullable

The From name; null = the address alone.

imap_passwordstring required

Stored by gtm.service.email, never here. Sent once, on this call.

smtp_passwordstring required

Stored by gtm.service.email, never here. Often the same value as imap_password, but both are required.

backfill_daysinteger nullable

How many days of existing mail gtm itself pulls from the server at connect; 0 = none, null = the gtm default. history_since is the bound on THIS side, over what gtm holds.

history_sincestring nullable

The mailbox's history window: import its mail from this day (YYYY-MM-DD) on, into the inbox and onto the linked people's activity, or nothing older than the connect 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.

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.