Update a user

Update a user of a client company. Only the attributes present in the body are updated. Unlike the regular endpoint, the email of a super admin or of a user whose company enforces SSO can be changed.

patch/reseller/companies/{company_uuid}/users/{uuid}

Request

  • Base URL: https://public-api.leexi.ai/v1
  • URL: https://public-api.leexi.ai/v1/reseller/companies/{company_uuid}/users/{uuid}
  • Auth: API key in header Authorization

Path parameters

company_uuidstring required

UUID of one of your client companies.

uuidstring required

UUID of the user.

Request body

activeboolean

Defaults to true on creation. Set to false to deactivate the user.

emailstring

The user's email address. It must be deliverable and not already used in any Leexi company.

licensestring

Either free or the client company's own license category. Any other value is ignored.

namestring

The user's full name.

rolesstring[]

Role names. Defaults to ["member"] on creation. Unlike the regular endpoints, a reseller key may assign every role, super_admin and system_admin included, and advanced roles do not require the Governance add-on of the client company.

team_uuidstring

The uuid of the team the user belongs to.

Response

200

messagestring
successboolean

Example response

{
  "data": {
    "active": true,
    "created_at": "2024-06-14T11:00:33.534Z",
    "email": "john.smith@acme.com",
    "license": "business",
    "name": "John Smith",
    "roles": [
      "member"
    ],
    "team": {
      "active": true,
      "name": "Sales Team",
      "uuid": "5290728d-b3c4-4330-918d-d8f153e9500d"
    },
    "updated_at": "2024-06-14T11:00:33.534Z",
    "uuid": "befb9860-8661-442a-9496-8743de9e17cd"
  },
  "message": "User successfully updated",
  "success": true
}

Changes

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