The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Composite Request

Returns a RestRequest object that you then use to execute the composite request.

Regardless of the number of subrequests, each composite request counts as one API call.

  • apiVersion (string)

  • requests

    • iOS

      • requests (array)—Array of subrequests
      • refIds (array)—Array of reference IDs for the requests. The number of elements should match the number of requests.
    • Android

      • refIdToRequests (map)— LinkedHashMap of reference IDs to RestRequest objects. Requests are played in the order in which they’re mapped.
  • allOrNone (Boolean)—Flag that indicates whether to treat all requests as a single transactional block in error conditions.