Create Bulk Read Job (ICS)
POST {{api-domain}}/crm/bulk/v3/read
To create a bulk read job to export records. Please see our API documentation for more information.
Request Body
{"callback"=>{"url"=>"https://www.example.com/callback", "method"=>"post"}, "query"=>{"module"=>{"api_name"=>"Leads"}, "file_type"=>"ics"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: Created
{"data":[{"status":"success","code":"ADDED_SUCCESSFULLY","message":"Added successfully.","details":{"id":"4876876000001294251","operation":"read","state":"ADDED","created_by":{"id":"4876876000000327001","name":"Patricia Boyle"},"created_time":"2022-05-23T12:15:20+05:30"}}],"info":{}}