Person Properties

Create multiple new person properties

post/properties/import

Request

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

Request body

namestring required

The name of the property

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

The type of the property

isUniqueboolean

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

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

[
  {
    "name": "Company Size",
    "propertyType": "SINGLE_SELECT",
    "propertyOptions": [
      {
        "name": "SMB (1 - 100 employees)",
        "color": "GREEN"
      },
      {
        "name": "Mid Market (101 - 2000 employees)",
        "color": "YELLOW"
      },
      {
        "name": "Enterprise (2000+ employees)",
        "color": "BLUE"
      }
    ],
    "description": "A description of the property"
  }
]

Response

The created person properties

Example response

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

Changes

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