API reference

Errors

Every error of the API has the same shape. Rely on code; message is for humans and may change.

The shape

{
  "error": {
    "code": "invalid_cursor",
    "message": "The cursor is not one this API issued."
  }
}

Code	Status	Meaning
`invalid_cursor`	400	The cursor is not one this API issued.
`invalid_email`	400	This is not a valid email address.
`invalid_idempotency_key`	400	The Idempotency-Key must be 1 to 255 visible ASCII characters.
`invalid_request`	400	The request could not be read or is missing a required field.
`unauthorized`	401	Missing, unknown or revoked key.
`origin_not_allowed`	403	This origin may not sign up for this product.
`waitlist_closed`	403	This waitlist takes no new sign-ups at the moment.
`not_found`	404	No such entry.
`unknown_product`	404	No product has this public key.
`already_invited`	409	The entry was already invited.
`already_redeemed`	409	The entry has redeemed its invitation; there is nothing to send again.
`idempotency_in_progress`	409	A request with this Idempotency-Key is still running.
`not_confirmed`	409	The entry has not confirmed its address yet and cannot be invited.
`not_invited`	409	The entry was not invited yet, so there is no invitation to send again.
`email_not_allowed`	422	This waitlist only takes addresses of certain domains, and this is not one of them.
`idempotency_key_reused`	422	This Idempotency-Key was already used for a different request.
`too_fast`	422	The form was submitted too fast, or without its elapsed time.
`rate_limited`	429	Too many requests. Retry after the number of seconds in Retry-After.
`mail_failed`	502	The mail could not be handed over. Nothing was changed; try again.