Update User

Update a user's skills, teams, and custom attributes.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed these limits, you will receive a 429 Rate Limit Exceeded response.

API Details

  • Looks up the user by Regal user UUID or exact login email. Users can include human or AI agents.
  • Email path values must be URL-encoded.
  • All request body fields are optional.
  • When provided, skills replaces the user's active routing skills. Use [] to clear all skills.
  • When provided, teams replaces the user's team membership. Use [] to clear all teams.
  • By default, customAttributes replaces the full custom attributes object.
  • Set mergeCustomAttributes to true to merge custom attributes into the existing object. Use null values to remove keys during merge.

Path Params
string
required

Regal user UUID or exact login email.

Body Params
skills
array of objects

Replaces routing skills for the user. Use [] to clear all skills.

skills
teams
array of strings

Replaces team membership. Each entry is a Regal team UUID or exact team name.

teams
boolean

When true, merges customAttributes; otherwise replaces the full object.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Validation error, unknown skill, team, or user.

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