Salesforce Subscriptions API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Subscriptions 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: Subscriptions
paths:
  /data/v64.0/chatter/subscriptions/{SUBSCRIPTION_ID}:
    parameters: []
    delete:
      tags:
      - Subscriptions
      summary: Salesforce Delete Subscription
      description: 'Information about the specified subscription. Also used to delete a subscription, for example, to unfollow a record or a topic.

        A subscription ID is returned as part of the response body for follower and following resources, for example, /records/recordId/followers. In addition, subscriptions IDs are also returned in many summary response bodies, such as group summary or user summary.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_subscriptions.htm'
      operationId: DeleteSubscription
      parameters:
      - name: SUBSCRIPTION_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - 0E8...
        example: '500123'
      responses:
        '204':
          description: No Content
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 11:34:47 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            Content-Security-Policy:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: upgrade-insecure-requests
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
          content: {}
      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:
    parameters: []
    post:
      tags:
      - Subscriptions
      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:
      - Subscriptions
      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:
      - Subscriptions
      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:
      - Subscriptions
      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:
      - Subscriptions
      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}".

        '