Skip to main content
POST
Start a mailbox connect for a sender profile

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_

Body

application/json

Request body of start_sender_profile_mailbox_connect.

provider
enum<string>
required

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

Available options:
google,
microsoft
success_redirect_url
string<uri> | null

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

Maximum string length: 2048
display_name
string | null

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

Maximum string length: 255
history_since
string | null

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.

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

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.

Available options:
all,
playtable_people

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required