Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

idempotency-key
string

Idempotency-Key: 1-255 printable ASCII characters. Same key with a different request body is a 422 idempotency_key_reused. A retryable in-flight duplicate is a 409 with Retry-After and x-should-retry: true; a terminal duplicate is a 409 with x-should-retry: false. A replay returns the current resource state with Idempotent-Replayed: true.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$
Example:

"b3f6a9f0-6f1a-4e9a-9e7a-9c9b6b6a5a3f"

Body

application/json
provider
enum<string>
required
Available options:
gmail
bindingHash
string

sha256 hex of the browser-held connect binding secret.

Pattern: ^[0-9a-f]{64}$
label
string
Maximum string length: 100

Response

Gmail mailbox link

address
string | null
required
connectionId
string<uuid>
required
mailboxId
string<uuid>
required
redirectUrl
string | null
required
status
enum<string>
required
Available options:
pending,
active,
expired,
removed