OS1 Services
...
Integrate with Participants
How To: Create & Update Participants In Batch
4 min
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 https //docs getos1 com/reference/perform create operation on participants in batch endpoint and specify the participanttypepluralname in the path parameter learn more about the necessary https //docs getos1 com/participant#q4hyj listed for creating participants in batch using the json the following examples show a request body for creating a batch participant request { "payload" \[ { "uniquecode" "qk6a ji6s 7etr", "name" "car1", "owner" "worldlogistics", "properties" { "color" "red" } }, { "uniquecode" "xnss hsjw 3ngu", "name" "car2", "owner" "worldlogistics", "properties" { "color" "blue" } }, { "uniquecode" "nhle l6mi 4ge4", "name" "car3", "owner" "worldlogistics", "properties" { "color" "black" } }, { "uniquecode" "6eti uil2 9wax", "name" "car4", "owner" "worldlogistics", "properties" { "color" "silver" } }, { "uniquecode" "2e62 e3sr 33fi", "name" "car5", "owner" "worldlogistics", "properties" { "color" "white" } } ], "callback" { "url" "https //examplecallbackurl com" } } create participants in batch via csv upload to create participants in batch through csv, call the https //docs getos1 com/reference/perform create operation on participants via file upload endpoint and specify the participanttypepluralname in the path parameter upload the csv file with all the details as shown in the https //github com/os1 logistics/bulk upload reference templates/blob/main/participant/participantbatchcreate csv updating participants in batch via json to update participants in batch, call the https //docs getos1 com/reference/perform update operation on participants in batch endpoint and specify the participanttypepluralname in the path parameter the following examples show a request body for updating a batch participant request { "payload" \[ { "id" "try\ d208e2b0 ab66 5738 8916 0d5271ec02a0", "properties" { "color" "blue" } } ] } updating participants in batch via csv upload to update participants in batch through csv, call the https //docs getos1 com/reference/perform create operation on participants via file upload endpoint and specify participanttypepluralname in the path parameter upload the csv file with all the details as shown in the https //github com/os1 logistics/bulk upload reference templates/blob/main/participant/participantbatchupdate csv retrieve participant batch status to retrieve the information about participants in batch processing, call the https //docs getos1 com/reference/qwsp get the status of batch file request endpoint and pass the participanttypepluralname , filebatchid in the path parameter this process is common to both json and csv based apis