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
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.
Whether the property is PHI (Protected health information)
Whether the property is PII (Personally Identifiable Information)
The description of the property
Response
The updated person property
An individual person property
The unique identifier of the property
The name of the property
The type of the property
STRING, NUMBER, DATETIME, BOOLEAN, SINGLE_SELECT, MULTI_SELECT, LOCATION "SINGLE_SELECT"
Options for a SINGLE_SELECT or MULTI_SELECT property. Empty for other property types.
Whether the property is unique across all people. Maximum of 10 across a workspace
Whether the property is PHI (Protected health information)
Whether the property is PII (Personally Identifiable Information)
The description of the property
The identifier of the property group this property belongs to. A property group is a collection of properties that apply to either all people in the workspace or a specific set of populations.