POST
Start sign-up by email
No sign-in needed For: Everyone Conditions
  • No sign-in is needed; the route allows 5 calls per minute.
  • The email must be a valid address (format and domain checked) of at most 255 characters; it is lower-cased and trimmed.
  • Callback URLs cannot be sent (login_callback_url, signup_callback_url and register_callback_url are refused); links are built from server configuration.
What else happens
  • Sends an onboarding email with a link to the frontend chosen by app (company by default). The link carries a token valid for 1 day for that address and a has_account flag.
  • The email content is the same type of mail for both cases, with type login when an account exists for the address and signup when it does not. The answer to the caller is identical in both cases.
Part of Sign up and sign in.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string<email>
required

Email address to start sign-up or sign-in for. It is lower-cased and trimmed; the link is sent there.

Maximum string length: 255
app
enum<string> | null

Application the emailed link opens: company or organization. Optional; defaults to company.

Available options:
company,
organization
login_callback_url
string

Not accepted: links are built from server configuration; sending this field is refused.

signup_callback_url
string

Not accepted: links are built from server configuration; sending this field is refused.

register_callback_url
string

Not accepted: links are built from server configuration; sending this field is refused.

Response

message
string
required

Confirmation text in the language of the request. Not meant to be parsed. It is the same whether or not an account exists for the address.