Salesforce Corporate API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Corporate 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: Corporate
paths:
  /data/v64.0/loyalty-programs/{loyaltyProgramName}/corporate-member-enrollments:
    parameters: []
    post:
      tags:
      - Corporate
      summary: Salesforce Corporate Member Enrollments
      description: 'Standard Documentation:


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_corporate_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_corporate_member.htm)'
      operationId: CorporateMemberEnrollments
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CorporateMemberEnrollmentsRequest'
              - examples:
                - enrollmentDate: '2021-01-01T05:05:05.000Z'
                  membershipNumber: Member123
                  associatedAccountDetails:
                    name: Name1
                    phone: '908989898'
                    website: www.ab.com
                    allowDuplicateRecords: 'false'
                  memberStatus: Active
                  createTransactionJournals: 'true'
              contentMediaType: application/json
            example:
              enrollmentDate: '2021-01-01T05:05:05.000Z'
              membershipNumber: Member123
              associatedAccountDetails:
                name: Name1
                phone: '908989898'
                website: www.ab.com
                allowDuplicateRecords: 'false'
              memberStatus: Active
              createTransactionJournals: 'true'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 May 2024 15:35:25 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-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
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/CorporateMemberEnrollments'
                - examples:
                  - accountId: 001J8000003MaJL
                    loyaltyProgramMemberId: 0lMJ8000000CaRH
                    loyaltyProgramName: NTO Insider
                    membershipNumber: Member123
                    transactionJournals:
                    - activityDate: '2021-01-01T04:05:05.000Z'
                      journalSubType: Member Enrollment
                      journalType: Accrual
                      loyaltyProgram: NTO Insider
                      loyaltyProgramMember: Member123
                      referredMember: null
                      status: Processed
                      transactionJournalId: 0lVJ8000000GmaE
                contentMediaType: application/json;charset=UTF-8
              example:
                accountId: 001J8000003MaJL
                loyaltyProgramMemberId: 0lMJ8000000CaRH
                loyaltyProgramName: NTO Insider
                membershipNumber: Member123
                transactionJournals:
                - activityDate: '2021-01-01T04:05:05.000Z'
                  journalSubType: Member Enrollment
                  journalType: Accrual
                  loyaltyProgram: NTO Insider
                  loyaltyProgramMember: Member123
                  referredMember: null
                  status: Processed
                  transactionJournalId: 0lVJ8000000GmaE
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CorporateMemberEnrollmentsRequest:
      title: CorporateMemberEnrollmentsRequest
      required:
      - enrollmentDate
      - membershipNumber
      - associatedAccountDetails
      - memberStatus
      - createTransactionJournals
      type: object
      properties:
        enrollmentDate:
          type: string
          example: example_value
        membershipNumber:
          type: string
          example: example_value
        associatedAccountDetails:
          $ref: '#/components/schemas/AssociatedAccountDetails'
        memberStatus:
          type: string
          example: example_value
        createTransactionJournals:
          type: string
          example: example_value
      examples:
      - enrollmentDate: '2021-01-01T05:05:05.000Z'
        membershipNumber: Member123
        associatedAccountDetails:
          name: Name1
          phone: '908989898'
          website: www.ab.com
          allowDuplicateRecords: 'false'
        memberStatus: Active
        createTransactionJournals: 'true'
    AssociatedAccountDetails:
      title: AssociatedAccountDetails
      required:
      - name
      - phone
      - website
      - allowDuplicateRecords
      type: object
      properties:
        name:
          type: string
          example: Example Title
        phone:
          type: string
          example: example_value
        website:
          type: string
          example: example_value
        allowDuplicateRecords:
          type: string
          example: example_value
      examples:
      - name: Name1
        phone: '908989898'
        website: www.ab.com
        allowDuplicateRecords: 'false'
    TransactionJournal:
      title: TransactionJournal
      required:
      - activityDate
      - journalSubType
      - journalType
      - loyaltyProgram
      - loyaltyProgramMember
      - referredMember
      - status
      - transactionJournalId
      type: object
      properties:
        activityDate:
          type: string
          example: example_value
        journalSubType:
          type: string
          example: example_value
        journalType:
          type: string
          example: example_value
        loyaltyProgram:
          type: string
          example: example_value
        loyaltyProgramMember:
          type: string
          example: example_value
        referredMember:
          type:
          - string
          - 'null'
          example: example_value
        status:
          type: string
          example: example_value
        transactionJournalId:
          type: string
          example: '500123'
      examples:
      - activityDate: '2021-01-01T04:05:05.000Z'
        journalSubType: Member Enrollment
        journalType: Accrual
        loyaltyProgram: NTO Insider
        loyaltyProgramMember: Member123
        referredMember: null
        status: Processed
        transactionJournalId: 0lVJ8000000GmaE
    CorporateMemberEnrollments:
      title: CorporateMemberEnrollments
      required:
      - accountId
      - loyaltyProgramMemberId
      - loyaltyProgramName
      - membershipNumber
      - transactionJournals
      type: object
      properties:
        accountId:
          type: string
          example: '500123'
        loyaltyProgramMemberId:
          type: string
          example: '500123'
        loyaltyProgramName:
          type: string
          example: example_value
        membershipNumber:
          type: string
          example: example_value
        transactionJournals:
          type: array
          items:
            $ref: '#/components/schemas/TransactionJournal'
          description: ''
          example: []
      examples:
      - accountId: 001J8000003MaJL
        loyaltyProgramMemberId: 0lMJ8000000CaRH
        loyaltyProgramName: NTO Insider
        membershipNumber: Member123
        transactionJournals:
        - activityDate: '2021-01-01T04:05:05.000Z'
          journalSubType: Member Enrollment
          journalType: Accrual
          loyaltyProgram: NTO Insider
          loyaltyProgramMember: Member123
          referredMember: null
          status: Processed
          transactionJournalId: 0lVJ8000000GmaE
  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}".

        '