Update user private data
Applies a partial update to the private data associated with the specified user. Only fields included in the request are updated. Private data fields can be removed by sending a null value for the corresponding key.
Intended for sensitive or internal-use attributes. Avoid exposing these values to client applications. If surfaced via custom claims, include them only in tokens issued to trusted backend services to prevent accidental disclosure.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The unique identifier of the user.
Request Body
application/json
The request payload used to update a user's private data.
TypeScript Definitions
Use the request body type in TypeScript.
Update Private Data Request: Updates private data associated with a user account.
Response Body
application/json
The user's private data was updated successfully
TypeScript Definitions
Use the response body type in TypeScript.
User Private Data: Returns private data stored for a user.
Errors
curl -X PATCH "https://your-domain.us.monocloud.com/api/users/WUgDGqaqzqkRmsgd3PFAT/private_data" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{ "private_data": { "property1": null, "property2": null } }'{ "private_data": { "property1": null, "property2": null }}