Salesforce Exchange API

The Exchange API from Salesforce — 1 operation(s) for exchange.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-exchange-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Exchange 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: Exchange
paths:
  /services/oauth2/token:
    parameters: []
    post:
      tags:
      - Exchange
      summary: Salesforce Registration - Token Exchange
      description: This exchanges the auth code returned in the Authorize Request for an access token and refresh token. This follows the standard Auth Code flow/Webserver Code Flow pattern. The Code is the return form the Authorization call.
      operationId: Registration-TokenExchange
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              required:
              - code
              - grant_type
              - client_id
              - redirect_uri
              type: object
              properties:
                code:
                  type: string
                  description: Auth Code from the Authorize response
                  examples:
                  - <code>
                grant_type:
                  type: string
                  examples:
                  - authorization_code
                client_id:
                  type: string
                  examples:
                  - '{{vault:salesforce-consumer-key}}'
                redirect_uri:
                  type: string
              contentMediaType: application/x-www-form-urlencoded
            examples:
              RegistrationTokenexchangeRequestExample:
                summary: Default Registration-TokenExchange request
                x-microcks-default: true
                value:
                  code: example_value
                  grant_type: example_value
                  client_id: '500123'
                  redirect_uri: example_value
        required: false
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      security: []
      servers:
      - url: https://login.salesforce.com
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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}".

        '