Salesforce Cancel API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Cancel 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: Cancel
paths:
  /data/v64.0/connect/loyalty/programs/{loyaltyProgramName}/program-processes/{processName}:
    parameters: []
    post:
      tags:
      - Cancel
      summary: Salesforce Cancel a Voucher
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_cancel_voucher.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_cancel_voucher.htm)


        In the Pre-request. Script Tab, make changes in the variables value accordingly with the real Process Name to invoke.'
      operationId: CancelaVoucher
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
          examples:
          - NTO Insider
        example: example_value
      - name: processName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CancelaVoucherRequest'
              - examples:
                - processParameters:
                  - MemberId: 0lMxx00000000BJEAY
                    VoucherId: 0kdxx000000000B245
              contentMediaType: application/json
            example:
              processParameters:
              - MemberId: 0lMxx00000000BJEAY
                VoucherId: 0kdxx000000000B245
        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:
    CancelaVoucherRequest:
      title: CancelaVoucherRequest
      required:
      - processParameters
      type: object
      properties:
        processParameters:
          type: array
          items:
            $ref: '#/components/schemas/ProcessParameter'
          description: ''
          example: []
      examples:
      - processParameters:
        - MemberId: 0lMxx00000000BJEAY
          VoucherId: 0kdxx000000000B245
    ProcessParameter:
      title: ProcessParameter
      required:
      - MemberId
      - VoucherId
      type: object
      properties:
        MemberId:
          type: string
          example: '500123'
        VoucherId:
          type: string
          example: '500123'
      examples:
      - MemberId: 0lMxx00000000BJEAY
        VoucherId: 0kdxx000000000B245
  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}".

        '