PUT
/
properties
/
{propertyId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

propertyId
string
required

Body

application/json

Input object for editing a person property. Pass all property options except ones that will be deleted

isPHI
boolean

Whether the property is PHI (Protected health information)

isPII
boolean

Whether the property is PII (Personally Identifiable Information)

name
string

The name of the property

propertyOptions
object[]

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

200 - application/json

An individual person property

isPHI
boolean
required

Whether the property is PHI (Protected health information)

isPII
boolean
required

Whether the property is PII (Personally Identifiable Information)

isUnique
boolean
required

Whether the property is unique across all people. Maximum of 10 across a workspace

name
string
required

The name of the property

propertyId
string
required

The unique identifier of the property

propertyOptions
object[]
required
propertyType
enum<string>
required

The type of the property

Available options:
STRING,
NUMBER,
DATETIME,
BOOLEAN,
SINGLE_SELECT,
MULTI_SELECT,
LOCATION