Skip to main content
POST
Invite someone

Authorizations

Authorization
string
header
required

An API key: ab_...

Body

application/json
email
string<email>
required
Maximum string length: 320
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
resource
enum<string>
required

What the grant is on; it reaches everything inside it

Available options:
organization,
workspace,
collection,
asset
resourceId
string<uuid>
required

The organization's, workspace's, collection's or asset's id

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
scope
enum<string>
required
Available options:
read,
propose,
write,
admin
limits
enum<string>[]

What the scope would allow but this grant doesn't: delete, share (links and upload requests), approve (review), setup (fields and brand)

Maximum array length: 4
Available options:
delete,
share,
approve,
setup

Response

The invitation, with its link

data
object
required