Skip to main content
POST
email.inbox.authorize

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
authToken
string
required

The 22-character code the app's pending sign-in showed.

Pattern: ^[A-Za-z0-9_-]{22}$
ref
string

The ref the inbox's create returned. Preferred over address.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
address
string

The inbox's email address, e.g. hello@example.com.

Required string length: 1 - 320
acceptDisclosure
boolean

Confirm the app's data-use disclosure on your own behalf.

Response

The result

authorized
boolean
required

Whether the app's sign-in was approved for this inbox.