v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Organization

Create User

Creates a new user in the specified organization. Requires a valid API key and proper permissions to create users. The user will be assigned to the specified team and given the specified role. Returns the created user's details including their UUID.

post/organizations/users

Request body

emailstring required

The email address of the new user.

first_namestring required

The first name of the new user.

last_namestring required

The last name of the new user.

passwordstring

The password for the new user's account.

roleUUIDstring required

The UUID of the role assigned to the user.

seat_type'listener' | 'recording'

The type of seat assigned to the user.

Example request

{
  "email": "15john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "password": "SecureP@ssw0rd!",
  "roleUUID": "84e67f54-5157-442b-a2b3-8b9c728b2fef1",
  "teams": [
    {
      "uuid": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4",
      "primary": true
    },
    {
      "uuid": "802a13d8-1ad0-4f4a-b880-9ace889fafa6",
      "primary": false
    }
  ],
  "seat_type": "recording"
}

Response

User successfully created

Example response

{
  "data": {
    "botName": "John's Notetaker",
    "email": "15john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "primaryTeamUUID": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4",
    "settings": {
      "autoCalculateCRMFields": true,
      "joinWhenIAmHostAndAlone": true,
      "joinWhenIAmHostWithPeers": true,
      "joinWhenUnlicensedPeerIsHost": true,
      "realTimeCapabilitiesOFF": true,
      "seat_type": "recording"
    },
    "transcriptLang": "en",
    "uuid": "c74eb7bc-7b0e-45e2-843a-67305bfc4dce"
  }
}