Skip to main content
POST
Invite team members

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Repeat a request safely: the same key and body answer the first request's job again with Idempotent-Replayed: true; the same key with a different body answers idempotency_conflict. 1 to 200 letters, digits, _ or -, such as a UUID

Pattern: ^[A-Za-z0-9_-]{1,200}$

Body

application/json
email
string

One address to invite; answers its Invitation

Maximum string length: 320
role
enum<string>

With email: its role (default member)

Available options:
owner,
admin,
member
invitations
object[]

Up to 500 addresses, each with an optional role; answers each row's result

csv
string

A CSV file's text: an email column and an optional role column, with or without a header row, up to 500 rows; answers each row's result

Response

With invitations or csv: each row's invitation or error, by index

results
object[]
required