Skip to main content
POST
Start a mailbox connect for a new 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.

Body

application/json

Request body of start_new_sender_profile_mailbox_connect.

provider
enum<string> | null

Pins gtm's hosted page to one flow: google or microsoft run the OAuth consent, imap_smtp shows the credentials form. Omitted, the page shows gtm's own picker.

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

Where gtm sends the human once the mailbox is connected. gtm follows it only for allow-listed hosts.

Maximum string length: 2048

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