Skip to main content
POST
/
api
/
v1
/
invitations
Create an invitation for a new member.
curl --request POST \
  --url https://api.backside.app/api/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access": [
    {
      "access_level": "<string>",
      "domain": "<string>"
    }
  ],
  "name": "<string>",
  "email": "<string>",
  "expires_in_days": 123,
  "role": "<string>"
}
'
{
  "claim_code": "<string>",
  "invitation": {
    "claim_token_prefix": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invited_access": "<unknown>",
    "invited_by_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "role": "<string>",
    "status": "<string>",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "claimed_at": "2023-11-07T05:31:56Z",
    "claimed_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
access
object[]
required
name
string
required
email
string | null
expires_in_days
integer<int64> | null
role
string | null

Response

Invitation created

claim_code
string
required
invitation
object
required