Sign in
Users

Update user profile and status

Overview

Modify profile details, subscription levels, or account status for an existing user.

Use Cases

  • Profile Correction: Correct a user's name or contact details.
  • Plan Management: Upgrade or downgrade a user's subscription (e.g., Enterprise vs. Basic).
  • Status Management: Activate or deactivate user access.
  • Access Refinement: Update team associations.

Identification

The {userId} is a unique numerical identifier.

Getting User ID

  • To find users and their numerical IDs, use the Users Management API:
    • GET /public/v1/users - Retrieve all users with their id field.
  • The id field in the user response is the {userId} used in this endpoint's path parameter.

Partial Updates

This endpoint supports partial updates. Only the fields provided in the request body will be changed; omitted fields and fields set to null will retain their current values.

Related Operations

  • Get Detail: GET /public/v1/users/{userId}
  • Manage Roles: POST /public/v1/users/{userId}/roles

Required Permission

manage_public_users

patch/public/v1/users/{userId}

Path parameters

userIdinteger required

The unique numerical identifier of the target user. If you do not have this ID, you can find it by searching for the user via GET /public/v1/users.

Request body

firstnamestring nullable
lastnamestring nullable
planIdinteger nullable
activeboolean nullable

Response

User profile and status successfully updated.

idinteger required
activeboolean required
confirmedboolean required
firstnamestring nullable
lastnamestring nullable
emailstring nullable

Changes

No recorded changes to this endpoint across all 9 revisions of this API.