POST · Account & access
Invite a guest to this account
Invite a guest to this account
/api/v1/account/guests
This scope is inferred from the method and the endpoint's group — the OpenAPI document does
not carry one per operation. The wire is authoritative; whoami reports what your
token actually holds.
Description
Takes email (and an optional role, which may only be all) and returns the created guest's id, email, guestId, linked, role and createdAt. Remove them later with manage_account_guests(remove).
Body
Send as application/json.
| Name | Type | Description |
|---|---|---|
email
required
|
string | |
role
|
enum |
One of all, null.
|
Responses
The specification does not describe this response body; the note in the rail says what to expect.
Every non-2xx response is an RFC 7807 problem with a stable
code.
Commonly returned errors
The codes this operation reaches on its own path: the auth stack, its own validation and
ownership checks, and the transport. Not a closed set — a shared code from the
full registry can still surface. Each links to the code’s own page,
the same URL its type dereferences to.