Participants

Import participants to a study

Import persons into a study. Supports all import properties within a person and also adds them as a participant. If the person is found then they are updated with any information included in here. 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.

post/studies/{studyId}/participants/import

Request

  • Base URL: https://api.rallyuxr.com/api/public/v1
  • URL: https://api.rallyuxr.com/api/public/v1/studies/{studyId}/participants/import
  • Auth: HTTP bearer

Path parameters

studyIdstring required

Request body

identifierPropertyIdstring

By default, "email" is used as the identifier. You can also use "phone" or provide the ID of a unique custom property to use as the identifier instead

populationIdstring

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

Example request

{
  "people": [
    {
      "email": "dev@rallyuxr.com",
      "phone": "+1 415 777-7777",
      "firstName": "Dev",
      "lastName": "Rally",
      "isOptedOut": false,
      "lastContactDate": "2025-01-01",
      "additionalEmails": [
        "dev+1@rallyuxr.com"
      ],
      "additionalPhones": [
        "+1-555-123-4568"
      ],
      "properties": [
        {
          "propertyId": "cm0b4eokq000vbbsimwelll3u",
          "value": "2025-01-01"
        },
        {
          "name": "Favorite Color",
          "propertyType": "STRING",
          "value": "Blue"
        }
      ]
    }
  ]
}

Response

The participants

messagestring required
countnumber required
importIdstring nullable required

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

Changes

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