Update a portal user

Changes a portal user's role, location scope or booking-notification setting. The
email in the path is matched case-insensitively. Absent properties are unchanged;
validation is the same as when adding a user. If nothing actually changes, the current
user is returned and no audit entry is written.

Last-admin guard: a provider must always have at least one Admin portal user.
Demoting an Admin when no other Admin remains fails with 409 last_admin.

Portal sessions cache the user's role, so a role change takes effect at their next
sign-in, not instantly. Changes are recorded in your activity log with a
field-by-field diff.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The portal user's email address (matched case-insensitively).

Body Params

A merge-update — absent properties are left unchanged.

string
enum

Case-insensitive. Demoting the last remaining Admin is rejected with 409 last_admin.

Allowed:
string
enum

Case-insensitive. When set to Selected, locationIds must be provided and non-empty.

Allowed:
locationIds
array of strings

The selected locations; validated against your locations. Only meaningful with a scope of Selected.

locationIds
boolean

Whether the user receives booking-notification emails.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json