v1

latestOpenAPI 3.1.02026-08-067019120.8 KB

Users

Update user information by ID

Updates information about the user with the given user_id. Requires admin, the same user ID as the API owner, or the access_user_info + edit_user_info permissions.

patch/api/user/{user_id}

Request body

first_namestring

The user's first name.

last_namestring

The user's last name.

countrystring

Country code (e.g. "US").

subdivisionfirststring

State.

subdivisionsecondstring

County.

subdivisionthirdstring

Municipality.

organizationstring

Organization name.

timezonestring

Time-zone string (e.g. "America/New_York").

languagestring

Language code (e.g. "en").

passwordstring

New password for the user.

old_passwordstring

Current password. Required when changing the password so that encrypted interview answers can be re-encrypted with the new key.

activeboolean

Whether the user account should be active. Cannot be changed for the current user or the original admin account.

Response

User information updated.