Ask for a dashboard sign in link

POST

/v1/dashboard/login

• Bookrail cloud.
• A local `pnpm dev`, on the default `PORT`.

Sends a single use link, valid for fifteen minutes, to the owner address of a self service account. The answer is the same 202 whether or not the address has an account. No API key.

Request Body ^required

object

email

required

string format: email

Example

you@example.com

upgrade

The plan the person was about to buy. The link carries it, and the dashboard opens the checkout of that plan after sign in.

string

Allowed values: pro scale

Responses

202

Success.

object

object

required

string

Allowed values: dashboard_login

email

required

The address, as it was understood.

string

expires_at

required

When a link sent for this request would stop working. The answer is the same whether or not the address has an account, and so whether or not a message is on its way.

string format: date-time

Example

2026-09-08T07:00:00Z

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

400

Error codes: invalid_body, parameter_invalid, parameter_missing, unsupported_api_version.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

429

Error codes: dashboard_login_rate_limited.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

500

Error codes: internal_error.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.

503

Error codes: dashboard_disabled.

object

error

required

object

type

required

string

Allowed values: invalid_request authentication permission not_found conflict rate_limit policy_violation payment_required internal

code

required

Machine readable code. The set is per operation; each response below lists the ones it can produce.

string

message

required

string

param

The field or header the error is about, when there is one.

string

fix

What to do next, when there is one thing to do. Present on the errors that are about the state of the deployment rather than about the request.

string

doc_url

required

string

request_id

required

string

Headers

Bookrail-Request-Id

required

string

Identifier of this request. Quote it to support.

Bookrail-Version

required

string

The API version this response was produced with.