Skip to main content
POST
auth.backend.email.set

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-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
host
string
required

Public hostname of your own SMTP service; not a URL.

Maximum string length: 253
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z][a-z0-9-]*$
port
integer
required

SMTP port supplied by your service.

Required range: 1 <= x <= 65535
username
string
required

SMTP username; write-only, never returned.

Required string length: 1 - 512
password
string
required

SMTP password; write-only, never returned or logged.

Required string length: 1 - 2048
senderEmail
string<email>
required

Sender address on a domain you own and have verified for sending.

Maximum string length: 320
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
senderName
string
required

App name shown in recovery emails.

Required string length: 1 - 128

Response

The result

recovery
object
required

Recovery settings after the update.