Update a person property by ID
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
Input object for editing a person property. Pass all property options except ones that will be deleted
Whether the property is PHI (Protected health information)
Whether the property is PII (Personally Identifiable Information)
The name of the property
Options for a SINGLE_SELECT
or MULTI_SELECT
property. Will error if passed and the type does not support them. Property options that are not included in this object will be deleted.
Response
An individual person property
Whether the property is PHI (Protected health information)
Whether the property is PII (Personally Identifiable Information)
Whether the property is unique across all people. Maximum of 10 across a workspace
The name of the property
The unique identifier of the property
The type of the property
STRING
, NUMBER
, DATETIME
, BOOLEAN
, SINGLE_SELECT
, MULTI_SELECT
, LOCATION