POST /crm/v3/__composite_requests

To perform a composite API call, consisting of one or up to five sub-requests. For more information, refer to the documentation.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
rollback_on_fail Boolean No
__composite_requests[] Array No
__composite_requests[].uri String No
__composite_requests[].params Object No
__composite_requests[].params.page String No
__composite_requests[].params.per_page String No
__composite_requests[].params.fields String No
__composite_requests[].method String No
__composite_requests[].sub_request_id String No
__composite_requests[].body Object No
__composite_requests[].body.data[] Array No
__composite_requests[].body.data[].Last_Name String No
__composite_requests[].headers Object No
__composite_requests[].headers.If-Modified-Since String No
concurrent_execution Boolean No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.