API Batch Mode Save Request
4 min
Introduction
The Batch Processing API allows users to upload a CSV file containing a list of entities, and perform actions on them in bulk.
sample curl
curl --request POST \
--url https://signzy.tech/api/v2/patrons/...patronID.../batchmodes \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'Authorization: <Access-Token>' \
--header 'content-type: application/json' \
--data '{"task":"save","essentials":{"url":"......csv url........","apiName":"...apiName...","emailId":["<emailId>"],"emailSubject":"...emailSubject...","callbackUrl":"...callbackUrl..."}}'
Field Name | Description | Value |
|---|---|---|
url | URL of the CSV file | Compulsory |
apiName | Name of the API | Compulsory |
emailId | List of email IDs to receive the response | Compulsory |
emailSubject | Subject of the email | Compulsory |
callbackUrl | URL to receive a callback | Compulsory |
Sample API Response
{
"result": {
"transactionId": "..transactionId.."
}
}
Field Name | Description |
|---|---|
transactionId | Transaction ID |