VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Analytics
Event capture
Create Person
List Persons
Request Person Erasure
Get Person Erasure
Get Person By Id
Update Person
Get Person Entitlements

Create Person

PreviousDelete PerkNextList Persons
POST
/api/v1/persons

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

distinctId*string
email?string|null
name?string|null
projectId?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/persons" \  -H "Content-Type: application/json" \  -d '{    "distinctId": "string"  }'
{  "personId": "string",  "distinctId": "string",  "email": "string",  "name": "string"}
{  "_tag": "Api/SdkValidationError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/PersonServiceError",  "cause": "string"}