persons

This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set and $unset properties, or one of our SDKs.

patch/api/projects/{project_id}/persons/{id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/persons/{id}/
  • Auth: HTTP bearer

Path parameters

idstring required

A unique value identifying this person. Accepts both numeric ID and UUID.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format'csv' | 'json'

Request body

idinteger

Numeric person ID.

namestring

Display name derived from person properties (email, name, or username).

distinct_idsstring[]
propertiesunknown
created_atstring date-time

When this person was first seen (ISO 8601).

uuidstring uuid

Unique identifier (UUID) for this person.

last_seen_atstring date-time nullable

Timestamp of the last event from this person, or null.

Response

idinteger required

Numeric person ID.

namestring required

Display name derived from person properties (email, name, or username).

distinct_idsstring[] required
propertiesunknown
created_atstring date-time required

When this person was first seen (ISO 8601).

uuidstring uuid required

Unique identifier (UUID) for this person.

last_seen_atstring date-time nullable required

Timestamp of the last event from this person, or null.

Changes

No recorded changes to this operation across all 1 revision of this API.