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.

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

Something wrong or missing on this page? Tell us by email or on Discord.

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

personId*string

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.

email?|

The new email address.

name?|

The new name.

traits?|

Traits to set; the newest write of each trait wins.

setOnce?|

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."  }}

Update a person

Errors

More in Persons

Update a person

Errors

More in Persons

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update a person

Update a person

person_not_found

project_not_found

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`