Skip to main content
POST
Attach a mailbox to 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 attach_sender_profile_mailbox.

email_account_sid
string
required

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

Required string length: 18
Pattern: ^em_ac_
connection_sid
string | null

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

Required string length: 18
Pattern: ^gt_cn_
history_since
string | null

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.

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 walk that starts on attach obeys it.

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