POST
/
studies
/
{studyId}
/
participants
/
import
curl --request POST \
  --url https://api.rallyuxr.com/api/public/v1/studies/{studyId}/participants/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "people": [
    {
      "email": "dev@rallyuxr.com",
      "firstName": "Dev",
      "lastName": "Rally",
      "isOptedOut": false,
      "lastContactDate": "2025-01-01",
      "additionalEmails": [
        "dev+1@rallyuxr.com"
      ],
      "properties": [
        {
          "propertyId": "cm0b4eokq000vbbsimwelll3u",
          "value": "2025-01-01"
        },
        {
          "name": "Favorite Color",
          "propertyType": "STRING",
          "value": "Blue"
        }
      ]
    }
  ]
}'
{
  "message": "<string>",
  "count": 123,
  "importId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
studyId
string
required

Body

application/json

Takes an object that contains an array of people to import. Internal properties are on the person object and custom properties can be specified either with the id of the property or an object that contains the name and property type. If a property with that name already exists then it will be used with no modification, if it does not exist then then property will be created before the import begins.

WARNING: These are treated as a PUT, not a PATCH. If you include a property in one person record and not another then the one that is missing it will have it removed

​
people
object[]
required

The people to import. If first/last name are null then they'll be overwritten

​
populationId
string

The ID of the population the person should be created/updated in. If not provided, the person will be created/updated across the workspace

Response

202
application/json
The participants

Response for importing people

​
message
string
required
​
count
number
required
​
importId
string | null
required

A unique identifier for the import, can be used to look up status and will be included in the webhook