Understanding the Import cURL Command
The Import cURL Command allows Site Admins and Site Managers to import participant data into Ripple’s Registry or a specific study directly from an Excel spreadsheet—without logging into the platform or using the Import Tool interface.
This method is useful when pulling data from external systems like Electronic Data Capture (EDC), Clinical Trial Management Systems (CTMS), or legacy databases. It allows you to efficiently update or populate Ripple with structured participant information in bulk.
Before You Begin
Before running the Import cURL Command, ensure the following:
-
Your data is in an Excel (.xlsx) file
-
The file follows Ripple’s Data Dictionary format
-
The file contains the appropriate Import Type
-
You have the necessary user permissions for the study or Registry
- Authorization Key
Understanding the Import cURL Command
The command you run must include:
Component | Description | |
---|---|---|
1 | Ripple Site URL | The base URL of the Ripple site you're importing data into |
2 | Import Type | Tells Ripple whether to import into the Registry or a specific study |
3 | Update Option | Defines how existing participant data should be handled |
4 | Authorization Key | Verifies your identity and permissions |
5 | Excel File Path | The file name and location on your device |
For Mac Users:
-
Ripple Site URL:
https://successplayground.ripplescience.com
-
Import Type:
(importing into a study)
-
Update Option:
all
(we want to update all participant information) -
Authorization: Provided using your user’s encoded credentials
-
Excel File:
AncillaryA.xlsx
, located on the desktop of user “Jane Doe”
To locate the Import Type for a specific study:
-
Open the study in Ripple
-
Copy the string of letters and numbers found in the URL after
/study/
-
Example: In
https://yourlab.ripplescience.com/study/abc1234/edit
, the Import Type isabc1234
-
-
- Use
"global"
(all lowercase) if you're importing into the Registry
- Use
Update Options Explained
When importing data, you must specify what Ripple should do if a participant already exists:
-
-
all
– Update All Information (including contacts) -
nocontact
– Do Not Update Contact Information -
noexisting
– Do Not Update Any Existing Participants
-
Note for Windows Users:
Use double quotes ("
) instead of single quotes ('
) and remove any backslashes (\
) used for line breaks in Mac/Linux commands.
File Requirements
-
Must be in .xlsx format
-
Must follow the column headers and structure defined by Ripple’s Data Dictionary
-
Do not include unsupported characters or formatting