Person Properties

Update a person property by ID

put/properties/{propertyId}

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/properties/{propertyId}
  • Auth: HTTP bearer

Path parameters

propertyIdstring required

Request body

namestring

The name of the property

isPHIboolean

Whether the property is PHI (Protected health information)

isPIIboolean

Whether the property is PII (Personally Identifiable Information)

descriptionstring

The description of the property

Example request

{
  "propertyOptions": [
    {
      "name": "SMB (1 - 100 employees)",
      "color": "GREEN"
    }
  ]
}

Response

The updated person property

propertyIdstring required

The unique identifier of the property

namestring required

The name of the property

propertyType'STRING' | 'NUMBER' | 'DATETIME' | 'BOOLEAN' | 'SINGLE_SELECT' | 'MULTI_SELECT' | 'LOCATION' required

The type of the property

isUniqueboolean required

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

isPHIboolean required

Whether the property is PHI (Protected health information)

isPIIboolean required

Whether the property is PII (Personally Identifiable Information)

descriptionstring nullable required

The description of the property

propertyGroupIdstring nullable required

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.

Example response

{
  "propertyType": "SINGLE_SELECT",
  "propertyOptions": [
    {
      "order": "1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.