Salesforce Automation

Salesforce Automation Batch API

Independent subrequests in a single call

Documentation GitHub OpenAPI

Documentation

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_oauth_and_connected_apps.htm

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/quickstart.htm

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_list.htm

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_limits.htm

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_quickstart.htm

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/authentication.htm

https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/

https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/quick_start.htm

https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/

https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/

https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_what_is_chatter_connect.htm

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickstart.htm

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_overview.htm

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/intro_rate_limits.htm

https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_actions_invocable.htm

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm

https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest.htm

https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_intro.htm

https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_restrequest.htm

Specifications

https://raw.githubusercontent.com/api-evangelist/salesforce-automation/refs/heads/main/openapi/salesforce-automation-batch-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/salesforce-automation/refs/heads/main/json-schema/salesforce-automation-flow-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/salesforce-automation/refs/heads/main/json-ld/salesforce-automation-context.jsonld

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/rest_rns.htm

PostmanCollection

https://www.postman.com/salesforce-developers/workspace/salesforce-developers/overview

https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/asynch_api_best_practices.htm

Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.platform_events.meta/platform_events/platform_events_intro.htm

Flow Object Reference

https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_flow.htm

https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/quickreference.htm

Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_what.htm

https://trailhead.salesforce.com/content/learn/modules/change-data-capture/understand-change-data-capture

Standard Actions Reference

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_actions_invocable_standard.htm

Custom Actions Reference

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_actions_invocable_custom.htm

https://developer.salesforce.com/docs/atlas.en-us.api_action.meta/api_action/actions_obj_flow.htm

Launch a Flow from REST API

https://help.salesforce.com/s/articleView?id=sf.flow_distribute_system_rest.htm&language=en_US&type=5

Developer Guide

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/using_composite_resources.htm

Composite Batch

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_batch.htm

Composite Graph

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/using_resources_composite_graph.htm

https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_rest_code_samples.htm

OpenAPI Specification

openapi: 3.1.0
info:
  title: Salesforce Analytics (CRM Analytics) REST Actions Batch API
  description: REST API for accessing and managing CRM Analytics (formerly Tableau CRM / Einstein Analytics) resources including datasets, lenses, dashboards, and dataflows. Enables programmatic access to analytics metadata, query execution, and dashboard management. Uses the Wave API resource at /services/data/vXX.0/wave.
  version: '63.0'
  contact:
    name: Salesforce Developer Support
    url: https://developer.salesforce.com/support
    email: developer@salesforce.com
  license:
    name: Salesforce API Terms of Use
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v63.0/wave
  description: Salesforce production or developer instance
  variables:
    instance:
      default: yourInstance
      description: Your Salesforce instance identifier
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Batch
  description: Independent subrequests in a single call
paths:
  /composite/batch:
    post:
      operationId: executeCompositeBatch
      summary: Execute composite batch request
      description: Executes up to 25 independent subrequests in a single call. Unlike the composite resource, batch subrequests are independent and cannot reference each other. If haltOnError is true, processing stops after the first error. Each subrequest counts as one API call, but the batch itself counts as one call toward the limit.
      tags:
      - Batch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRequest'
      responses:
        '200':
          description: Batch response with results for each subrequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponse'
components:
  schemas:
    BatchResponse:
      type: object
      properties:
        hasErrors:
          type: boolean
        results:
          type: array
          items:
            type: object
            properties:
              statusCode:
                type: integer
              result:
                description: The response body
    BatchRequest:
      type: object
      required:
      - batchRequests
      properties:
        haltOnError:
          type: boolean
          default: false
          description: If true, stops processing after the first error
        batchRequests:
          type: array
          maxItems: 25
          items:
            type: object
            required:
            - method
            - url
            properties:
              method:
                type: string
                enum:
                - GET
                - POST
                - PATCH
                - PUT
                - DELETE
              url:
                type: string
              richInput:
                description: The request body
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
          tokenUrl: https://login.salesforce.com/services/oauth2/token
          scopes:
            api: Access and manage your Salesforce data
            wave_api: Access CRM Analytics REST API resources
    bearerAuth:
      type: http
      scheme: bearer