PUT
/
properties
/
{propertyId}
curl --request PUT \
  --url https://api.rallyuxr.com/api/public/v1/properties/{propertyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "propertyOptions": [
    {
      "name": "SMB (1 - 100 employees)",
      "color": "GREEN"
    }
  ],
  "isPHI": true,
  "isPII": true
}'
{
  "propertyId": "<string>",
  "name": "<string>",
  "propertyType": "SINGLE_SELECT",
  "propertyOptions": [
    {
      "propertyOptionId": "<string>",
      "name": "<string>",
      "color": "GREY",
      "order": "1"
    }
  ],
  "isUnique": true,
  "isPHI": true,
  "isPII": true
}

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

​
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.

Input object for adding a property option to a SINGLE_SELECT or MULTI_SELECT property

​
isPHI
boolean

Whether the property is PHI (Protected health information)

​
isPII
boolean

Whether the property is PII (Personally Identifiable Information)

Response

200
application/json
The updated person property

An individual person property

​
propertyId
string
required

The unique identifier of the property

​
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
Example:

"SINGLE_SELECT"

​
propertyOptions
object[]
required

An individual person property option

​
isUnique
boolean
required

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

​
isPHI
boolean
required

Whether the property is PHI (Protected health information)

​
isPII
boolean
required

Whether the property is PII (Personally Identifiable Information)