Skip to main content
POST
Invite a member by email

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Client-generated idempotency key (≤255 chars). Replays the cached response when the same (team, key) pair sees an identical request body within 24h; returns 409 idempotency_key_reused if the body differs. Recommended for every billable POST.

Maximum string length: 255
Autousers-Version
string

Date-pinned API version (e.g. 2026-05-04). Omit to receive the latest stable version. Behaves like Stripe's Stripe-Version — pinning a version freezes payload shapes against breaking changes during the 12-month sunset window.

Path Parameters

id
string
required

cuid of the resource

Body

application/json
email
string<email>
required
role
enum<string>
default:Editor
Available options:
Owner,
Admin,
Editor,
Viewer

Response

Invited

id
string
required
teamId
string
required
userId
string
required
role
enum<string>
required
Available options:
Owner,
Admin,
Editor,
Viewer
createdAt
string<date-time>
required
{key}
any