castomAPI
Get your key
POST /v1/salesforce/composite from 1 token API key Salesforce

Run up to 25 Salesforce REST subrequests as one call

Run up to 25 Salesforce REST subrequests as one call. optionally transactional (allOrNone) and chainable (@{referenceId.field}). Salesforce counts the whole call as ONE request against the org's own daily quota. Salesforce's own sub-limit of at most 5…

POST

Request

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Response 

{
  "results": [],
  "status": "success",
  "summary": {
    "failed": 34,
    "succeeded": 25,
    "total": 3
  },
  "tokensDeducted": 1
}
The response below is a mock built from the endpoint's own schema — no request leaves this page. Edit the body, press Send, read the shape you will get back. Run it for real in the dashboard →

What it does

Run up to 25 Salesforce REST subrequests as one call. optionally transactional (allOrNone) and chainable (@{referenceId.field}). Salesforce counts the whole call as ONE request against the org's own daily quota. Salesforce's own sub-limit of at most 5 query/sObject-collection subrequests per call is NOT enforced here. it would need us to parse each url to guess its kind, and Salesforce's own rejection names the rule better than a guess would. The outer HTTP status is always 200: inspect each result's httpStatusCodeuccessful subrequest, minimum 1

Request

Body

FieldTypeRequiredDescription
accountIdstringno
allOrNonebooleannoRoll the whole set back if any subrequest fails (Salesforce default: false)
collateSubrequestsbooleanno
compositeRequestarray<object>yes
  ↳ bodyobjectno
  ↳ httpHeadersobjectnoPer-subrequest headers (If-Match, Sforce-Auto-Assign, ...). Authorization is rejected -- subrequests inherit the connection's own token
  ↳ methodenumyesOne of: GET, POST, PUT, PATCH, DELETE, HEAD.
  ↳ referenceIdstringyesReferenced by sibling subrequests as @{thisId.Field}
  ↳ urlstringyesFull relative REST path, e.g. /services/data/v67.0/sobjects/Account/ -- note this endpoint wants the /services/data prefix and /composite/batch does not

Example request

{
  "accountId": "acc_144960",
  "allOrNone": true,
  "collateSubrequests": true,
  "compositeRequest": [
    {
      "body": {},
      "httpHeaders": {
        "key": "example"
      },
      "method": "GET",
      "referenceId": "ref_600177",
      "url": "https://example.com/page"
    }
  ]
}

Response

FieldTypeDescription
resultsarray<object>
statusstring
summaryobject
  ↳ failedinteger
  ↳ succeededinteger
  ↳ totalinteger
tokensDeductedinteger

Example response

{
  "results": [],
  "status": "success",
  "summary": {
    "failed": 34,
    "succeeded": 25,
    "total": 3
  },
  "tokensDeducted": 1
}

Errors

Every error answers with the same envelope: an HTTP status, a machine code and a sentence.

400The body or a parameter failed validation. The details array names the field.
401No key, a revoked key or a wrong header. Send x-api-key.
402The wallet cannot cover this call. Top up or wait for the monthly grant.
404The resource does not exist, or it is not yours. Both answer identically and cost nothing.
429Over the per-minute quota of your tier. Back off and retry.
5xxUpstream refused or timed out. The call is not billed.

Code

curl -X POST 'https://app.castomapi.com/v1/salesforce/composite' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]}'
const res = await fetch('https://app.castomapi.com/v1/salesforce/composite', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/salesforce/composite', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accountId": "acc_144960", "allOrNone": true, "collateSubrequests": true, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/salesforce/composite',
    headers={'x-api-key': '<your-api-key>'},
    json={"accountId": "acc_144960", "allOrNone": True, "collateSubrequests": True, "compositeRequest": [{"body": {}, "httpHeaders": {"key": "example"}, "method": "GET", "referenceId": "ref_600177", "url": "https://example.com/page"}]},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/salesforce/composite');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['accountId' => 'acc_144960', 'allOrNone' => true, 'collateSubrequests' => true, 'compositeRequest' => [['body' => [], 'httpHeaders' => ['key' => 'example'], 'method' => 'GET', 'referenceId' => 'ref_600177', 'url' => 'https://example.com/page']]]),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Cost and limits

This operation costs from 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire. 1 token per action that actually succeeded, with a floor of 1.

Rate limits per minute

No key10
Free60
Pro300
Enterprise1200

Docs → Pricing

Questions

What does Run up to 25 Salesforce REST subrequests as one call cost?

from 1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month. 1 token per action that actually succeeded, with a floor of 1.

How do I authenticate?

Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.

Can I send an Authorization: Bearer token instead?

Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.

What are the limits?

10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.

OpenAPI: https://app.castomapi.com/docs/json