Sign in
latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB

5de55d3804cf

Organization

Update User

Updates an existing user's information in the organization. You can modify the user's name, email, team assignment, and role. Requires proper permissions to update user details.

patch/organizations/users/{userId}

Path parameters

userIdstring required

UUID of the user to update

Request body

firstNamestring
lastNamestring
passwordstring
botNamestring
dealsEnabledboolean
teamUUIDsToRemovestring[]
roleUUIDstring

The UUID of the role assigned to the user.

seat_type'listener' | 'recording'

The type of seat assigned to the user.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "password": "newPassword123",
  "botName": "JohnBot4",
  "dealsEnabled": false,
  "teamUUIDsToRemove": [
    "802a13d8-1ad0-4f4a-b880-9ace889fafa61"
  ],
  "teamsToAdd": [
    {
      "uuid": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4",
      "primary": true
    },
    {
      "uuid": "802a13d8-1ad0-4f4a-b880-9ace889fafa6",
      "primary": false
    }
  ],
  "roleUUID": "84e67f54-5157-442b-a2b3-8b9c728b2fef1",
  "seat_type": "recording"
}

Response

User successfully updated

Example response

{
  "data": {
    "botName": "John's Notetaker",
    "email": "15john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "primaryTeamUUID": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4",
    "roles": [
      {
        "name": "Sales Rep",
        "type": "SALES_REP",
        "uuid": "55906d03-2849-4c3c-a67f-da07a6300de4"
      }
    ],
    "settings": {
      "autoCalculateCRMFields": true,
      "joinWhenIAmHostAndAlone": true,
      "joinWhenIAmHostWithPeers": true,
      "joinWhenUnlicensedPeerIsHost": true,
      "realTimeCapabilitiesOFF": true,
      "seat_type": "recording"
    },
    "transcriptLang": "en",
    "uuid": "c74eb7bc-7b0e-45e2-843a-67305bfc4dce"
  }
}