Create Bulk Read Job (ICS)
POST {{api-domain}}/crm/bulk/v2/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"=>"Contacts", "fields"=>["Last_Name", "Owner", "Owner.last_name", "Account_Name.Account_Name", "Account_Name.Phone", "Lead_Source", "Created_Time"], "criteria"=>{"group_operator"=>"or", "group"=>[{"api_name"=>"Lead_Source", "comparator"=>"equal", "value"=>"Advertisement"}, {"api_name"=>"Owner.last_name", "comparator"=>"equal", "value"=>"Boyle"}, {"api_name"=>"Account_Name.Phone", "comparator"=>"contains", "value"=>"5"}]}, "page"=>1}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |
RESPONSES
status: Created
{"data":[{"status":"success","code":"ADDED_SUCCESSFULLY","message":"Added successfully.","details":{"id":"738964000002152095","operation":"read","state":"ADDED","created_by":{"id":"738964000000291009","name":"Patricia Boyle"},"created_time":"2021-05-12T06:54:24+00:00"}}],"info":{}}