Skip to main content
POST
Invite a person into your account

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Body

application/json

POST /v1/tenants/me/invites — invite one address into the caller's account.

email
string
required

The address to invite. Stored lowercased; accepting requires the signed-in account's address to equal it. A domain literal, an IP domain, a domain without a dot, or over 254 characters is refused with 400 UZ-REQ-001.

Response

Created

One invite, as the account's owner sees it.

created_at
integer<int64>
required

When it was issued, epoch milliseconds.

email
string
required

The address it is for, lowercased.

email_status
string
required

What became of its most recent email: sent, failed, or unconfigured when this deployment has no mail relay set up.

expires_at
integer<int64>
required

When it stops being acceptable, epoch milliseconds.

id
string
required

The invite's identifier.

The dashboard page the invitee opens to accept it.

role
string
required

The role accepting it grants: member.

email_sent_at
integer<int64> | null

When the relay last accepted its email, epoch milliseconds; null if it never has.