Skip to content
  • Auto
  • Light
  • Dark
Get started

Update

Update user
client.users.update(stringexistingUsername, UserUpdateParams { id, email, firstName, 5 more } body?, RequestOptionsoptions?): void
put/user/{username}

This can only be done by the logged in user.

ParametersExpand Collapse
existingUsername: string
body: UserUpdateParams { id, email, firstName, 5 more }
id?: number
email?: string
firstName?: string
lastName?: string
password?: string
phone?: string
username?: string
userStatus?: number

User Status

formatint32
Update user
import JustinDocsTest from 'justin-docs-test';

const client = new JustinDocsTest({
  apiKey: 'My API Key',
});

await client.users.update('username');
Returns Examples