Update a User

put

https://api.revenium.ai/profitstream/v2/api/users/{id}

Updates an existing user, identified by ID. Fields you leave out, or send as null or an empty list, keep their current values. The email address cannot be changed, so send the user's current email.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the user to update. This is the Revenium-generated hashid returned when the user was created, visible in the user list endpoint, and used in all user-related API operations. Format: URL-safe encoded string.

Body Params

user

string

required

The email address of the user

firstName

string | null

The first name of the user

lastName

string | null

The last name of the user

phoneNumber

string | null

The phone number associated with the user

homepagePreference

string | null

enum

The user's homepage preference

persona

string | null

enum

The user's role-based UI persona (cxo_finance, product_leaders or platform_engineering)

Allowed:

roles

array of strings

required

The roles of the user

roles*

tenant

Metadata of an account resource with its usage-based-billing opt-in

teamIds

array of strings

The IDs of the teams the user belongs to

teamIds

defaultTeamId

string | null

The ID of the default team to load on login

primaryUser

boolean | null

Whether this is the primary user of the account

redirectUrl

string | null

The URL to use for the magic link invitation email. If not provided, uses the platform default URL.

canViewPromptData

boolean | null

Whether the user can view captured prompt data (system prompts, messages, and responses). This flag only affects non-admin users; Account Administrators (ROLE_TENANT_ADMIN) have implicit access regardless of this setting. Only modifiable by Account Administrators.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/hal+json

*/*

200Returns the updated User object.

400Invalid input data

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found

409Conflict - Resource conflict

422Unprocessable entity - Validation failed

429Too Many Requests

504Gateway Timeout