For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunitySign Up
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
    • Introduction
  • REST Call Control
  • REST Platform Management
      • POSTcreate a new user
      • GETretrieve user information
      • PUTupdate user information
      • DELdelete a user
  • Webhooks
    • GETNew Call
    • POSTNew Call
    • POSTClient Authentication
    • POSTNew Client Tool Request
  • Websocket API
LogoLogo
CommunitySign Up
REST Platform ManagementUsers

update user information

PUT
https://api.jambonz.cloud/v1/Users/:UserSid
PUT
/v1/Users/:UserSid
$curl -X PUT https://api.jambonz.cloud/v1/Users/UserSid \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Alice Johnson",
>  "email": "alice.johnson@example.com",
>  "email_activation_code": "A1B2C3D4E5",
>  "old_password": "OldPass!2023",
>  "new_password": "NewPass!2024",
>  "is_active": true,
>  "force_change": false,
>  "is_view_only": false
>}'
1{}
Was this page helpful?
Previous

delete a user

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

UserSidstringRequired

Request

This endpoint expects an object.
namestringOptional
emailstringOptional
email_activation_codestringOptional
old_passwordstringOptional
existing password, which is to be replaced
new_passwordstringOptional
new password
is_activebooleanOptional
force_changebooleanOptional
is_view_onlybooleanOptional
if set to true the user will not be able to make changes

Response

user updated

Errors

403
Forbidden Error
500
Internal Server Error