Skip to main content
POST
Invite a user

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

The details needed to invite someone to the organization.

invitee_email_address
string
required

Email address to send the invitation to.

Pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$

Response

Successful Response

A pending invitation for someone to join the organization.

id
string
required
read-only

The unique identifier of the invitation.

inviter_name
string
required
read-only

Name shown to the invitee as the sender — the inviting member's email address, or the creator of the API key the invitation was sent with.

invitee_email_address
string
required
read-only

Email address the invitation was sent to.

create_time
string
required
read-only

When the invitation was sent — RFC 3339 UTC, e.g. 2026-06-05T10:30:00Z.

expiry_time
string
required
read-only

When the invitation stops being redeemable — RFC 3339 UTC. After this the invitee must be invited again.

invitation_url
string | null
required

One-time link that redeems the invitation. Anyone holding it can join the organization as the invitee, so share it only with them.