Create a sign-in link

API 0.16.0OpenAPIllms-full.txt

POST/v1/auth/login-link

Your server calls POST /v1/auth/login-link with X-API-Key and X-Customer-ID. Set mailbox_id to open only that mailbox; omit it to open the entire account. locale selects the interface language.

Authentication and access · Errors and retries

Request

curl -X POST 'https://adapt-mail.com/v1/auth/login-link' \
  -H 'X-API-Key: <mail-api-key>' \
  -H 'X-Customer-ID: <mail-account-id>' \
  -H 'Content-Type: application/json' \
  --data '{"mailbox_id":1,"locale":"en"}'

Parameters

X-Customer-IDheaderNecessarily

integer

minimum: 1

Request body · application/json

object

mailbox_id

Option 1

integer

exclusiveMinimum: 0

Option 2

null

locale

string

Valid values: "en" "ru" "fr" "es" "de" "zh-cn" "ko" "tr" "hi" "pt-br"

Default: "en"

Unknown fields are not accepted.

Responses

201 Successful response

application/json

object

login_urlNecessarily

string

expires_inNecessarily

integer

300

expires_atNecessarily

string

account_idNecessarily

integer

mailbox_idNecessarily

Option 1

integer

Option 2

null

Unknown fields are not accepted.

401 Request error

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

403 Request error

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

404 Request error

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

422 Request error

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object

503 Request error

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array elements

object