How to Use the Import cURL API to Import Data into Ripple

Site Admins and Site Managers can use Ripple’s Import cURL API to import data in bulk from a third-party system—such as a CTMS, EDC, or CRM—into the Registry or a specific study. This eliminates the need to log into Ripple to manually use the Import Tool and helps keep your data harmonized across platforms.

What You Need Before You Start

To successfully run the Import cURL command, you’ll need the following:

• Ripple Site URL

• Study ID (or "global" for the Registry)

• Update Option for handling existing participants

• Authorization Key

• Name and location of the Excel file on your device

• The appropriate Import cURL Command based on your operating system

Format Your Data First

Before using the Import API, your Excel file must:

• Use the .xlsx format

• Follow the correct column names and formats listed in the Ripple Data Dictionary

• Contain only existing fields in Ripple (new variables cannot be created via import)

Import cURL Command

For Mac Users:

For Windows Users:

Step-by-Step Instructions

1. Open your command line tool:

   • Mac: Open Terminal

   • Windows: Open Command Prompt

2. Paste in the Import cURL command.

3. Replace the placeholders:

Update Options

Specify how Ripple should treat existing participants:

Action	What to Use in Command
Update All Information	all
Do Not Update Contact Information	nocontact
Do Not Update Any Existing Participants	noexisting

 

Example Import cURL Command

You are importing custom variable data and event completion records into the Ancillary A study. All participants already exist, and you want to update all participant data.