Create a person

Creates a person for a distinct id.

When a person already has the distinct id, writes the given email and name onto them and returns them instead of creating another.

Guide: People and identity

Errors

This operation adds no error codes of its own. It can 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.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

distinctId*string

The distinct id your app knows the person by, such as your own user id. A person who already has it is updated instead.

Length1 <= length

email?|

The person's email address.

name?|

The person's name.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/persons" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "distinctId": "user_8231",    "email": "ada@example.com",    "name": "Ada Lovelace"  }'

{  "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: Missing key\n  at [\"distinctId\"]"  }}

{  "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": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

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

Create a person

Errors

More in Persons

Create 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`

Create a person

Create a person

201application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`