Composite Requests

POST {{api-domain}}/crm/v4/__composite_requests

Request Body

{"rollback_on_fail"=>true, "concurrent_execution"=>false, "__composite_requests"=>[{"sub_request_id"=>"1", "method"=>"POST", "uri"=>"/crm/v4/Leads", "body"=>{"data"=>[{"Last_Name"=>"Sam"}]}}, {"sub_request_id"=>"2", "method"=>"PUT", "uri"=>"/crm/v4/Leads/@{1:$.data[0].details.id}", "body"=>{"data"=>[{"Company"=>"ZT"}]}}, {"sub_request_id"=>"3", "method"=>"GET", "params"=>{"fields"=>"Last_Name,Company,Email", "per_page"=>"3", "page"=>"1"}, "uri"=>"/crm/v4/Leads/@{2:$.data[0].details.id}"}, {"sub_request_id"=>"4", "method"=>"GET", "params"=>{"fields"=>"Last_Name, Modified_Time"}, "headers"=>{"If-Modified-Since"=>"2019-09-23T12:30:00+05:30"}, "uri"=>"/crm/v4/Leads"}, {"sub_request_id"=>"5", "method"=>"GET", "params"=>{"fields"=>"Last_Name, Modified_Time"}, "uri"=>"/crm/v4/Leads/554023000001736019"}]}

RESPONSES

status: OK

{"__composite_requests":[{"code":"SUCCESS","details":{"response":{"headers":{"X-ACCESSTOKEN-RESET":"2022-05-23T12:37:00+05:30","Content-Disposition":"attachment; filename=response.json","content-type":"application/json;charset=utf-8","clientVersion":"5038531","clientsubVersion":"825a81583dbf9157ac7702db9870523e"},"status_code":201,"body":{"data":[{"code":"SUCCESS","details":{"Modified_Time":"2022-05-23T11:49:26+05:30","Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"Created_Time":"2022-05-23T11:49:26+05:30","id":"4876876000001294186","Created_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"$approval_state":"approved"},"message":"record added","status":"success"}]}}},"message":"composite sub request executed successfully","status":"success"},{"code":"SUCCESS","details":{"response":{"headers":{"X-ACCESSTOKEN-RESET":"2022-05-23T12:37:00+05:30","Content-Disposition":"attachment; filename=response.json","content-type":"application/json;charset=utf-8","clientVersion":"5038531","clientsubVersion":"825a81583dbf9157ac7702db9870523e"},"status_code":200,"body":{"data":[{"code":"SUCCESS","details":{"Modified_Time":"2022-05-23T11:49:27+05:30","Modified_By":{"name":"Patricia Boyle","id":"4876876000000327001"},"Created_Time":"2022-05-23T11:49:26+05:30","id":"4876876000001294186","Created_By":{"name":"Patricia Boyle","id":"4876876000000327001"}},"message":"record updated","status":"success"}]}}},"message":"composite sub request executed successfully","status":"success"},{"code":"SUCCESS","details":{"response":{"headers":{"X-ACCESSTOKEN-RESET":"2022-05-23T12:37:00+05:30","Content-Disposition":"attachment; filename=response.json","content-type":"application/json;charset=utf-8","clientVersion":"5038531","clientsubVersion":"825a81583dbf9157ac7702db9870523e"},"status_code":200,"body":{"data":[{"Company":"ZT","Email":null,"Last_Name":"Sam","id":"4876876000001294186","$canvas_id":null}]}}},"message":"composite sub request executed successfully","status":"success"},{"code":"SUCCESS","details":{"response":{"headers":{"X-ACCESSTOKEN-RESET":"2022-05-23T12:37:00+05:30","Content-Disposition":"attachment; filename=response.json","content-type":"application/json;charset=utf-8","clientVersion":"5038531","clientsubVersion":"825a81583dbf9157ac7702db9870523e"},"status_code":200,"body":{"data":[{"Last_Name":"Jacob","id":"4876876000001299005"},{"Last_Name":"Sam","id":"4876876000001294186"},{"Last_Name":"Perry","id":"4876876000001236143"},{"Last_Name":"Contact_test","id":"4876876000001236130"},{"Last_Name":"Contact_test","id":"4876876000001236115"},{"Last_Name":"Boyle","id":"4876876000001212372"},{"Last_Name":"Boyle","id":"4876876000001212351"},{"Last_Name":"Boyle","id":"4876876000001212204"},{"Last_Name":"Daly","id":"4876876000001212148"},{"Last_Name":"Perry","id":"4876876000001212135"},{"Last_Name":"Sam","id":"4876876000001168001"},{"Last_Name":"Fox","id":"4876876000001125137"},{"Last_Name":"Contact_test","id":"4876876000001105002"},{"Last_Name":"Last_Name1","id":"4876876000001095085"},{"Last_Name":"Boyle","id":"4876876000001081542"},{"Last_Name":"Perry","id":"4876876000000900134"},{"Last_Name":"Dylan","id":"4876876000000376008"},{"Last_Name":"Last_Name","id":"4876876000000376007"},{"Last_Name":"Maclead (Sample)","id":"4876876000000333412"},{"Last_Name":"Kidman (Sample)","id":"4876876000000333411"},{"Last_Name":"Merced (Sample)","id":"4876876000000333410"},{"Last_Name":"Sweely (Sample)","id":"4876876000000333409"},{"Last_Name":"Lace (Sample)","id":"4876876000000333407"},{"Last_Name":"Frey (Sample)","id":"4876876000000333404"},{"Last_Name":"Kitzman (Sample)","id":"4876876000000333403"}],"info":{"call":false,"per_page":25,"next_page_token":null,"count":25,"page":1,"previous_page_token":null,"page_token_expiry":null,"email":false,"more_records":false}}}},"message":"composite sub request executed successfully","status":"success"},{"code":"SUCCESS","details":{"response":{"headers":{"X-ACCESSTOKEN-RESET":"2022-05-23T12:37:00+05:30","X-Content-Type-Options":"nosniff","Content-Disposition":"attachment; filename=response.json","X-Download-Options":"noopen","content-type":"application/json;charset=utf-8","clientVersion":"5038531","clientsubVersion":"825a81583dbf9157ac7702db9870523e"},"status_code":204,"body":null}},"message":"composite sub request executed successfully","status":"success"}]}