Salesforce · JSON Structure

Salesforce Rest Composite Request Structure

A composite request containing an ordered series of subrequests where later requests can reference the results of earlier ones using reference IDs.

Type: object Properties: 3 Required: 1
Fortune 500Artificial IntelligenceAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

CompositeRequest is a JSON Structure definition published by Salesforce, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

allOrNone collateSubrequests compositeRequest

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "A composite request containing an ordered series of subrequests where later requests can reference the results of earlier ones using reference IDs.\n",
  "name": "CompositeRequest",
  "properties": {
    "allOrNone": {
      "type": "boolean",
      "description": "If true, all subrequests must succeed or all changes are rolled back. If false, subrequests are processed independently.\n"
    },
    "collateSubrequests": {
      "type": "boolean",
      "description": "If true, similar subrequests are grouped for more efficient processing.\n"
    },
    "compositeRequest": {
      "type": "array",
      "description": "Ordered array of subrequests. Later subrequests can reference results from earlier ones using @{referenceId.field} syntax.\n",
      "items": {
        "type": "object",
        "properties": {
          "method": {
            "type": "string",
            "description": "HTTP method for this subrequest.",
            "enum": [
              "GET",
              "POST",
              "PATCH",
              "DELETE"
            ]
          },
          "url": {
            "type": "string",
            "description": "Relative URL for this subrequest."
          },
          "referenceId": {
            "type": "string",
            "description": "Unique identifier for this subrequest. Used to reference this subrequest's results in subsequent subrequests.\n"
          },
          "body": {
            "type": "object",
            "description": "Request body for POST and PATCH subrequests."
          }
        },
        "required": [
          "method",
          "url",
          "referenceId"
        ]
      }
    }
  },
  "required": [
    "compositeRequest"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/salesforce-rest-composite-request-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.