Salesforce

Salesforce Managed API

The Managed API from Salesforce — 3 operation(s) for managed.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-managed-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-managed-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Managed 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: Managed
paths:
  /data/v64.0/tooling/sobjects/ManagedEventSubscription:
    parameters: []
    post:
      tags:
      - Managed
      summary: Salesforce Create Managed Event Subscription
      operationId: Createmanagedeventsubscription
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreatemanagedeventsubscriptionRequest'
              - examples:
                - FullName: Managed_Sub_OpportunityChangeEvent
                  Metadata:
                    label: Managed Sub OpportunityChangeEvent
                    topicName: /data/OpportunityChangeEvent
                    defaultReplay: LATEST
                    state: RUN
                    errorRecoveryReplay: LATEST
              contentMediaType: application/json
            example:
              FullName: Managed_Sub_OpportunityChangeEvent
              Metadata:
                label: Managed Sub OpportunityChangeEvent
                topicName: /data/OpportunityChangeEvent
                defaultReplay: LATEST
                state: RUN
                errorRecoveryReplay: LATEST
        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
  /data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}:
    parameters: []
    get:
      tags:
      - Managed
      summary: Salesforce Get Managed Event Subscription by Id
      operationId: GetmanagedeventsubscriptionbyID
      parameters:
      - name: managedEventSubscriptionId
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      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
    patch:
      tags:
      - Managed
      summary: Salesforce Update Managed Event Subscription
      operationId: Updatemanagedeventsubscription
      parameters:
      - name: managedEventSubscriptionId
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdatemanagedeventsubscriptionRequest'
              - examples:
                - FullName: Managed_Sub_OpportunityChangeEvent
                  Metadata:
                    state: STOP
              contentMediaType: application/json
            example:
              FullName: Managed_Sub_OpportunityChangeEvent
              Metadata:
                state: STOP
        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
    delete:
      tags:
      - Managed
      summary: Salesforce Delete Managed Event Subscription
      operationId: Deletemanagedeventsubscription
      parameters:
      - name: managedEventSubscriptionId
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      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
  /data/v64.0/tooling/sobjects/ManagedEventSubscription/describe:
    parameters: []
    get:
      tags:
      - Managed
      summary: Salesforce Describe Managed Event Subscription
      operationId: Describemanagedeventsubscription
      parameters: []
      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:
    Metadata13:
      title: Metadata13
      required:
      - state
      type: object
      properties:
        state:
          type: string
          example: example_value
      examples:
      - state: RUN
    CreatemanagedeventsubscriptionRequest:
      title: CreatemanagedeventsubscriptionRequest
      required:
      - FullName
      - Metadata
      type: object
      properties:
        FullName:
          type: string
          example: example_value
        Metadata:
          $ref: '#/components/schemas/Metadata15'
      examples:
      - FullName: Managed_Sub_OpportunityChangeEvent
        Metadata:
          label: Managed Sub OpportunityChangeEvent
          topicName: /data/OpportunityChangeEvent
          defaultReplay: LATEST
          state: RUN
          errorRecoveryReplay: LATEST
    UpdatemanagedeventsubscriptionRequest:
      title: UpdatemanagedeventsubscriptionRequest
      required:
      - FullName
      - Metadata
      type: object
      properties:
        FullName:
          type: string
          example: example_value
        Metadata:
          $ref: '#/components/schemas/Metadata13'
      examples:
      - FullName: Managed_Sub_OpportunityChangeEvent
        Metadata:
          state: STOP
    Metadata15:
      title: Metadata15
      required:
      - label
      - topicName
      - defaultReplay
      - state
      - errorRecoveryReplay
      type: object
      properties:
        label:
          type: string
          example: Example Title
        topicName:
          type: string
          example: example_value
        defaultReplay:
          type: string
          example: example_value
        state:
          type: string
          example: example_value
        errorRecoveryReplay:
          type: string
          example: example_value
      examples:
      - label: Managed Sub OpportunityChangeEvent
        topicName: /data/OpportunityChangeEvent
        defaultReplay: LATEST
        state: RUN
        errorRecoveryReplay: LATEST
  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}".

        '