API reference

API reference · Account

Set the address and send it a one time link

PUT/api/account/emailSigned in session

At most 3 links an hour. The confirmed address keeps receiving until a new one is confirmed.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
emailrequiredstring

Example

{
  "email": "string"
}

Answer 200

The link was sent.

Fields of the 200 answer
FieldTypeWhat it is
enabledboolean
emailstring or null
verifiedAtinteger or null
pendingEmailstring or null
pendingExpiresAtinteger or null

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 429OpenAI shaped error.
  • 502OpenAI shaped error.
  • 503OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter