POST /api/v2/invites
Create invite to workspace

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: signUpForm
}

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",
    ...
  ],
  "workspace": {
    "id": 1,
    "name": "Scrum Launch",
    "available_users_count": 30,
    "can_add_new_users": true,
    "can_invite_users_count": 29,
    "workspace_roles": [
      {
        "id": 1,
        "name": "super_admin",
        "users": [
          {
            "id": 1,
            "first_name": "Vadim",
            "last_name": "Kruchina",
            "email": "kruchina.vadim@gmail.com",
            "avatar_image": null,
            "invite_status": "acceped",
            "invite_id": 1
          }
        ]
      },
      {
        "id": 2,
        "name": "creative_admin",
        "users": []
      },
      {
        "id": 3,
        "name": "creator",
        "users": []
      },
      {
        "id": 4,
        "name": "editor",
        "users": [
          {
            "id": 2,
            "first_name": "Vadim",
            "last_name": "Kruchina",
            "email": "kruchina.vadim+1@gmail.com",
            "avatar_image": null,
            "invite_status": "pending",
            "invite_id": 1
          }
        ]
      }
    ]
  }
}

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.