Configuration

Update User

Modify a user's name, role, or profile settings. Requires account admin role.

patch/api/v2/users/{user_id}

Request

Base URL
https://app.freeplay.ai (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/freeplay/apis/freeplay-api/docs/api/v2/users/:user_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

user_idstring required

Request body

first_namestring nullable

last_namestring nullable

account_role'Account User' | 'Account Admin' | 'Account Analyst' | 'Account Guest'

profile_picturestring nullable

profile_colorstring nullable

Response

UserResponse(id: uuid.UUID, email_address: str, first_name: str, last_name: str, account_role: str, is_deleted: bool, profile_picture: Optional[str] = None, profile_color: Optional[str] = None)

idstring uuid required

email_addressstring required

first_namestring required

last_namestring required

account_rolestring required

is_deletedboolean required