provider persons PATCH /api/projects/{project_id}/persons/{id}/
@utdk/posthog /api/projects/{project_id}/persons/{id}/
persons_partial_update
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.
format query
enum: csv, json
id path required
A unique value identifying this person. Accepts both numeric ID and UUID.
string
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string

Try it

Authentication
Configure credentials for PostHog API
personsPartialUpdate
PATCH/api/projects/{project_id}/persons/{id}/
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.

Parameters

required

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

required

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

Input

Numeric person ID.

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

Key-value map of person properties set via $set and $set_once operations.

When this person was first seen (ISO 8601).

Unique identifier (UUID) for this person.

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

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.personsPartialUpdate()