Users

Invite User

Required scopes: user (Read and Write).

post/users

Request

Request body

emailstring required

Invited user email

firstNamestring

Invited user first name

lastNamestring

Invited user last name

timezonestring

Invited user timezone

adminAccessboolean

Grant admin access to an organization

Example request

{
  "email": "john@example.com",
  "firstName": "Jon",
  "lastName": "Doe",
  "timezone": "America/New_York"
}

Response

User was successfully invited

Example response

{
  "data": {
    "id": 12,
    "username": "john_smith",
    "firstName": "John",
    "lastName": "Smith",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    },
    "isAdmin": true,
    "status": "active",
    "createdAt": "2019-07-11T07:40:22+00:00",
    "lastSeen": "2019-10-23T11:44:02+00:00",
    "email": "jsmith@example.com",
    "twoFactor": "enabled",
    "timezone": "Europe/Kyiv",
    "joinDetails": {
      "type": "privateInvitation",
      "invitedBy": {
        "id": 19,
        "username": "john_doe",
        "fullName": "John Smith"
      }
    },
    "deviceVerification": "enabled",
    "loginMethods": [
      "crowdin"
    ],
    "mfaMethods": [
      "authenticatorApp"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.