Create invite link

Invite a new user to the organization and create an invite link for them. If the email already belongs to a pending user, a new invite link is generated for them. Only available to organization admins.

POST /api/v1/invite-links

Error

A valid request URL is required to generate request examples

201

{
  "results": {
    "email": "<string>",
    "userUuid": "<string>",
    "organizationUuid": "<string>",
    "inviteUrl": "<string>",
    "inviteCode": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Body

application/json

the email, role and expiry of the invite. expiresAt defaults to 3 days from now when omitted

the email, role and expiry of the invite. expiresAt defaults to 3 days from now when omitted

email · string · required

role · enum<string>

Available options: member, viewer, interactive_viewer, editor, developer, admin

expiresAt · string<date-time>

Response

201

application/json

Created

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok