klink-developers-logo

User

Update

PATCH/api/v1/users/{id}

Updates a user. Send only the fields you want to change — anything you omit is left exactly as it was, including roles.

Supply password only when you intend to reset it. Omit it and the existing password is preserved.

Supplying roleIds replaces the user's roles rather than adding to them. Read the current roles with Detail first if you mean to append.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Path Params
  • idstringrequired

    User ID.

    Example:

Body Paramsapplication/json
  • namestringoptional

    Cannot contain @.

  • emailstringoptional
  • passwordstringoptional

    New password. Omit to keep the current one.

  • roleIdsarray[string]optional

    Replaces the existing roles.

  • phonestring | nulloptional
  • addressstring | nulloptional
  • globalAgentCapacityinteger | nulloptional

Responses

200

OK

  • requestIdstringrequired

    Unique ID for this request. Quote it when reporting a problem.

  • dataobjectrequired
    Child attributes
    • idstringrequired
    • namestringrequired
    • emailstringrequired
    • phonestring | nullrequired
    • addressstring | nullrequired
    • globalAgentCapacityinteger | nullrequired

      Maximum concurrent conversations for this agent, or null to fall back to the queue setting.

    • rolesarray[object]required
      Child attributes
      • idstringrequired

        Role ID. Use this in roleIds when creating or updating a user.

      • systemNamestringrequired
      • displayNamestringrequired
      • descriptionstring | nullrequired
    • createdAtstringrequired
    • updatedAtstringrequired
401

Unauthorized

  • messagestringrequired
404

Not Found

  • messagestringrequired
422

Unprocessable Entity

  • messagestringrequired
429

Too Many Requests

  • messagestringrequired