Salesforce Launch API

The Launch API from Salesforce — 1 operation(s) for launch.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-launch-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Launch API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Launch
paths:
  /data/v64.0/actions/custom/flow/{flowApiName}:
    parameters: []
    post:
      tags:
      - Launch
      summary: Salesforce Launch Flow
      description: Launches an Autolaunched Flow with the supplied input parameters.
      operationId: LaunchFlow
      parameters:
      - name: flowApiName
        in: path
        description: Flow API Name
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LaunchFlowRequest'
              - examples:
                - inputs:
                  - {}
              contentMediaType: application/json
            example:
              inputs:
              - {}
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LaunchFlowRequest:
      title: LaunchFlowRequest
      required:
      - inputs
      type: object
      properties:
        inputs:
          type: array
          items:
            type: object
          description: ''
          example: []
      examples:
      - inputs:
        - {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '