Update name

PATCH

/users/user_private_data/update_name/v1

Updates the caller’s name in WorkOS and private user data. | (UserPrivateDataNameUpdateReq) -> (UserPrivateData1)

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

namestringRequired1-255 characters

Successful Response

_idstring

created_at_timestampdatetime

schema_versioninteger

user_idstring

Must be a string starting with user_

firebase_cloud_messaging_token_datalist of objectsOptional

namestringOptional1-255 characters

phone_numberstringOptional

primary_email_addressstringOptionalformat: "email"

422

Private Data Update Name V1request Unprocessable Entity Error

1	import { ChrtClient } from "@chrt-inc/typescript-sdk";
2
3	async function main() {
4	const client = new ChrtClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.users.privateData.updateNameV1({
8	name: "name",
9	});
10	}
11	main();

1	{
2	"_id": "_id",
3	"created_at_timestamp": "2024-01-15T09:30:00Z",
4	"schema_version": 1,
5	"user_id": "user_id",
6	"firebase_cloud_messaging_token_data": [
7	{
8	"firebase_cloud_messaging_token": "firebase_cloud_messaging_token",
9	"last_used_timestamp": "2024-01-15T09:30:00Z",
10	"platform": "android"
11	}
12	],
13	"name": "name",
14	"phone_number": "phone_number",
15	"primary_email_address": "primary_email_address"
16	}