Skip to content
Get started

Update

client.users.me.update(MeUpdateParams { has_completed_onboarding } body?, RequestOptionsoptions?): MeUpdateResponse { user }
PATCH/users/me

Update the current authenticated user.

ParametersExpand Collapse
body: MeUpdateParams { has_completed_onboarding }
has_completed_onboarding?: boolean
ReturnsExpand Collapse
MeUpdateResponse { user }
user: User { id, created_at, email, 5 more }

The current authenticated user.

id: string

The unique identifier of the user.

created_at: unknown

The time the user was created.

email: string

The email address of the user.

first_name: string | null

The first name of the user.

has_completed_onboarding: boolean

Whether the user has completed the onboarding tutorial.

last_name: string | null

The last name of the user.

organization_id: string

The ID of the organization the user belongs to.

updated_at: unknown

The time the user was last updated.

Update

import Revox from '@revoxai/sdk';

const client = new Revox({
  apiKey: process.env['REVOX_API_KEY'], // This is the default and can be omitted
});

const me = await client.users.me.update();

console.log(me.user);
{
  "user": {
    "id": "id",
    "created_at": {},
    "email": "email",
    "first_name": "first_name",
    "has_completed_onboarding": true,
    "last_name": "last_name",
    "organization_id": "organization_id",
    "updated_at": {}
  }
}
Returns Examples
{
  "user": {
    "id": "id",
    "created_at": {},
    "email": "email",
    "first_name": "first_name",
    "has_completed_onboarding": true,
    "last_name": "last_name",
    "organization_id": "organization_id",
    "updated_at": {}
  }
}