Skip to main content
POST
Adds someone to your organisation the only way a member is added: by invitation. They are emailed a link that works once, for seven days, and they become a member, with the role you give, when they accept it. Until then they are a pending invitation. This is what Send invitation in the console’s Members screen does. The answer is the same for every address. Whether the address has no account on this deployment, has one, or already belongs to a member of your organisation, you get 202 with the same body. Someone who is already a member is left exactly as they are: no second seat, no change of role, and no email. So this endpoint never tells you which addresses have accounts. To change a role, use Change a role. This endpoint takes a signed-in console session, not an API key. Send the session cookies your browser received when you signed in, plus the X-CSRF-Token header set to the value of the csrf_token cookie. A request authenticated with an mithunai_sk_ key is refused with 403, whatever the key’s role: adding a person would turn a leaked key into access that outlives revoking it. You need the owner or admin role, and you cannot invite to a role above your own; asking for one returns 403. An address that already has an open invitation returns 409: re-send it instead. When your deployment cannot send email you get 503, and when the mail provider refuses the message 502; in both cases nothing is created. See Members and Invitations.
Changed on 1 November 2026. This endpoint used to add an account that already existed straight away, answering 201 with the member, 404 for an address with no account and 409 for an existing member. It now always invites and answers 202. If you relied on the member in the response, read List members once the person has accepted.
string
required
The value of your session’s csrf_token cookie (named __Host-csrf_token when the console is served over HTTPS without a shared cookie domain). A missing or mismatched token returns 401.
string
required
The address to invite. Up to 255 characters.
string
default:"normal"
The role they join with: admin, editor, normal or dataset_operator. normal is the member role. Ownership is never invited; owner returns 400. See Organisations and roles.

Response

Returns 202 Accepted, with the same body whatever the address.
boolean
required
Always true.
string
required
The address, in lower case.
string
required
The role the invitation carries.
Last modified on November 7, 2026