Skip to main content
POST
/
properties
/
import
Create multiple new person properties
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/properties/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "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"
      }
    ],
    "isUnique": false,
    "isPHI": false,
    "isPII": false
  }
]
'
{
  "results": [
    {
      "personProperty": {
        "propertyId": "<string>",
        "name": "<string>",
        "propertyType": "SINGLE_SELECT",
        "propertyOptions": [
          {
            "propertyOptionId": "<string>",
            "name": "<string>",
            "color": "GREY",
            "order": "1"
          }
        ],
        "isUnique": true,
        "isPHI": true,
        "isPII": true
      },
      "isAsync": true,
      "bulkActionUserRequestId": "<string>"
    }
  ],
  "errors": [
    {
      "message": "<string>",
      "path": [
        "<string>"
      ],
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
Maximum array length: 10
​
name
string
required

The name of the property

Example:

"Company Size"

​
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[]

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

Maximum array length: 100
Example:
[
  {
    "name": "SMB (1 - 100 employees)",
    "color": "GREEN"
  },
  {
    "name": "Mid Market (101 - 2000 employees)",
    "color": "YELLOW"
  },
  {
    "name": "Enterprise (2000+ employees)",
    "color": "BLUE"
  }
]
​
isUnique
boolean

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

Example:

false

​
isPHI
boolean

Whether the property is PHI (Protected health information)

Example:

false

​
isPII
boolean

Whether the property is PII (Personally Identifiable Information)

Example:

false

Response

The created person properties

​
results
object[]
required

The person properties that were created

​
errors
object[]
required

The properties that failed to create