OS1 Services
...
Participant
Integrate with Participants

How To: Create & Update Participants In Batch

4min

For information about prerequisites, see Integrate with Participant.

Batch endpoints are provided to create and update Participants in batches. The Batch endpoints support two methods to supply the Participant data:

  • JSON
  • CSV file upload

Create Participants in Batch via JSON

To create Participants in batch, call the Create Batch request endpoint and specify the participantTypePluralName in the path parameter.

Learn more about the necessary attributes listed for creating Participants in Batch using the JSON.

The following examples show a request body for creating a Batch Participant request:

JSON


Create Participants in Batch via CSV Upload

To create Participants in batch through CSV, call the File Upload Create Request endpoint and specify the participantTypePluralName in the path parameter. Upload the CSV file with all the details as shown in the sample CSV.

Updating Participants In Batch Via JSON

To update Participants in batch, call the Update Batch Request endpoint and specify the participantTypePluralName in the path parameter. The following examples show a request body for updating a Batch Participant request:

JSON


Updating Participants In Batch Via CSV Upload

To update Participants in batch through CSV, call the File Upload to Update Participants Request endpoint and specify participantTypePluralName in the path parameter. Upload the CSV file with all the details as shown in the sample CSV.

Retrieve Participant Batch Status

To retrieve the information about Participants in Batch processing, call the Get the Status of Batch Request endpoint and pass the participantTypePluralName, FileBatchId in the path parameter. This process is common to both JSON and CSV-based APIs.