POST
/
properties
/
import

Authorizations

Authorization
string
header
required

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

Body

application/json · object[]
name
string
required

The name of the property

propertyType
enum<string>
required

The type of the property

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

Whether the property is PHI (Protected health information)

isPII
boolean

Whether the property is PII (Personally Identifiable Information)

isUnique
boolean

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

propertyOptions
object[]

Options for a SINGLE_SELECT or MULTI_SELECT property. Errors if passed for other property types

Response

200 - application/json
errors
object[]
required

The properties that failed to create

results
object[]
required

The person properties that were created