Skip to main content

Update a user

PATCH 
/api/v1/domains/:domain_uuid/users/:user_uuid

Updates an existing FS PBX user in the specified account. Use this endpoint to change profile details, enable or disable the user, or revise their extension, roles, managed accounts, and location assignments. Returns the updated user profile.

This is a partial update: all fields are optional, and omitted fields and assignments are preserved. Send extension_uuid: null to unassign the extension. If groups is supplied, it must contain at least one existing role UUID; an empty array is rejected.

Directory-managed identity and status cannot be changed here. Directory-managed email and extension assignments are protected, and directory-managed roles are preserved. Local roles may still be changed with the appropriate permission.

Requires domain access and user_edit. Changes to roles, status, and managed accounts require the same additional permissions as creation. Non-superadmins cannot modify superadmins or users above their role level.

Request​

Responses​