Skip to main content
POST
Reconnect a sender profile mailbox

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_
emailAccountSid
string
required

Which mailbox of the sender profile to re-credential (em_ac_…).

Required string length: 18
Pattern: ^em_ac_

Body

application/json

Request body of reconnect_sender_profile_mailbox.

imap_password
string | null

New IMAP password for an imap_smtp mailbox. Passed straight to gtm and never stored here.

Maximum string length: 1024
smtp_password
string | null

New SMTP password for an imap_smtp mailbox.

Maximum string length: 1024
success_redirect_url
string<uri> | null

For an OAuth mailbox: where gtm sends the human after the consent it answers with. 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