Update a person
Changes a person's email, name or traits.
The newest write of a trait in traits wins; a trait in setOnce is kept only when the person has none yet.
Guide: People and identity
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The person's id, person_.... The id of a person merged into another names the person they were merged into.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The new email address.
The new name.
Traits to set; the newest write of each trait wins.
Traits to set only when the person has none of that name yet; a traits write still wins over them.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/persons/person_h7d2k9m4x1c6v8b3n5q0w2e7" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "email": "ada@example.com", "traits": { "plan": "pro", "seats": 3 }, "setOnce": { "signupSource": "ios" } }'{ "id": "person_h7d2k9m4x1c6v8b3n5q0w2e7", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "distinctId": "user_8231", "email": "ada@example.com", "name": "Ada Lovelace", "isIdentified": true, "createdAt": "2026-03-02T14:05:11.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Expected object" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "person_not_found", "message": "This project has no person person_h7d2k9m4x1c6v8b3n5q0w2e7.", "param": "personId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | person_not_found | For an unknown or erased person. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Persons
- List persons
GET - Create a person
POST - Retrieve a person
GET - List a person's entitlements
GET - List a person's purchases
GET - List a person's subscriptions
GET - Erase a person
POST - Retrieve an erasure
GET
Something wrong or missing on this page? Tell us by email or on Discord.