Skip to main content
PATCH
Update user settings
This endpoint changes the settings of one of your platform users: their name and email, their permissions, their minute rate, their limits and what they see on your platform. Send only the keys you want to change: everything you leave out stays as it is. The response returns all the user’s settings after the change, in the same format as Get user settings.
This endpoint is available to the account owner (with an active plan) and to team members who can open the administration panel, meaning they have Platform Admin, Settings Access or Billing Access. Only the owner can change permissions. Team members can change everything else, on their own account too, as in the administration panel. Only users of your platform can be changed: any other ID, including the owner account, returns 404.

Path Parameters

integer
required
The ID of the user. Administrators can list user IDs with Get platform users.

Request Body

string
The user’s name, up to 255 characters. It cannot contain <, >, links or domain names.
string
The user’s email address. It must be a valid email address that is not already used by another user of your platform or by the owner account.
object
The user’s permissions in your administration panel. Only the account owner can send this key; for anyone else the request returns 403 and nothing is saved. Permissions you leave out stay unchanged. See Permissions for what each one allows.
number
The rate per minute this user is charged, in your currency, instead of the rate of their plan or your default rate. Up to 4 decimals, and at least your own cost per minute. minimum_minute_cost in Get default limits is that cost rounded up to the cent, so it is always accepted. null removes the custom rate, and the user goes back to the rate of their plan or your default rate.
object
The user’s own limits, which take priority over their plan and your default limits. The keys are those of default limits except calendar_integrations: assistants, campaigns, cloned_voices, knowledgebases, mid_call_tools, parallel_calls, automation_runs and own_numbers are count limits, and web_widget, secondary_languages, automation_platform, custom_dashboards, ai_prompt_editor, flow_builder and ai_connector are boolean limits.Count limits take an integer from -1 to 100000 (-1 means unlimited, 0 means none). Boolean limits take true or false. null on a key removes that limit from the user, who then gets the limit of their plan or your default limit again. Limits you leave out stay unchanged. limits: null removes all of the user’s own limits.
object
What the user sees on your platform. For each page and feature, the user sees your platform-wide setting unless you give them a different one, and the pages and features you leave matching your platform-wide appearance keep following it when you change it later. A list you send replaces the current list for this user, and a value sent twice is saved once. appearance: null returns the user to your platform-wide appearance and clears visible_plans.

Response

string
Success message
object
All the user’s settings after the change, in the same format as Get user settings. permissions is returned only to the account owner

Permissions

The first three permissions let a team member open your administration panel, where every administrator can manage your users. They can then use these user settings endpoints, and the other endpoints their permissions allow.

Partial updates

  • Keys you leave out stay unchanged. Inside permissions and limits, only the keys you send change.
  • A list you send (hide_pages, hide_features or visible_plans) replaces that list for the user. An appearance object without one of these lists keeps the user’s current value for it.
  • An unknown top-level field returns 422 with “The X field is not supported.”, and an unknown key inside permissions, limits or appearance returns 422 with “The X field must be an object with only the supported keys.”. In both cases nothing is saved, not even the valid parts of the request.
  • Leading and trailing spaces are removed from text values.
  • Send only the keys you want to change.

Rate limit

The platform settings, default limits, user settings and plan endpoints share a limit of 60 requests per minute for each account. Above it they return 429, and the Retry-After response header tells you how many seconds to wait.

Example: Change a user’s rate, limits and appearance

Example: Give a team member Settings Access (owner only)

Example: Return a user to your defaults