POST /api/v4/invites
Create invite to workspace. Last update: 29/10/24

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "user_emails": [
    "sample_email@gmail.com",
    ...
  ],
  location: workspaceSettingsPage
}

Success response body ↑

{
  "successfully_invited_users": [
    "kruchina.vadim+3@gmail.com",
    ...
  ],
  "already_invited_users": [
    "kruchina.vadim+2@gmail.com",
    ...
  ],
  "already_on_workspace": [
    "kruchina.vadim+1@gmail.com",
    ...
  ],
  "invalid_emails": [
    "invalid_email@gmail.com",
    ...
  ]
}

Params

Param name Description
user_emails
required

Array of user emails

Validations:

  • Must be an array of String
location
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, templateBranding.