Skip to main content
POST
email.account.connect.start

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own identifier for the person connecting their mailbox.

Required string length: 1 - 256
returnUrl
string
required

Page to return to after connecting. Accepts a public HTTPS URL, or http on localhost for a local install.

Response

The result

connectUrl
string
required

Short-lived sign-in link on our host.

expiresAt
string
required

When the sign-in link expires, UTC.

ref
string

Reference to what this call created. Pass it as ref to email.account.connect.status.