Salesforce

Salesforce Individual API

The Individual API from Salesforce — 1 operation(s) for individual.

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


        [https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm](https://developer.salesforce.com/docs/atlas.en-us.loyalty.meta/loyalty/connect_resources_enroll_individual_member.htm)'
      operationId: IndividualMemberEnrollments
      parameters:
      - name: loyaltyProgramName
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/IndividualMemberEnrollmentsRequest'
              - examples:
                - enrollmentDate: '2021-01-01T00:00:00.000Z'
                  membershipNumber: Member1
                  associatedContactDetails:
                    firstName: Name1
                    lastName: Name2
                    email: ab@email.com
                    allowDuplicateRecords: 'false'
                  memberStatus: Active
                  createTransactionJournals: 'true'
                  transactionJournalStatementFrequency: Monthly
                  transactionJournalStatementMethod: Mail
                  enrollmentChannel: Email
                  canReceivePromotions: 'true'
                  canReceivePartnerPromotions: 'true'
                  membershipEndDate: '2022-01-01T00:00:00.000Z'
              contentMediaType: application/json
            example:
              enrollmentDate: '2021-01-01T00:00:00.000Z'
              membershipNumber: Member1
              associatedContactDetails:
                firstName: Name1
                lastName: Name2
                email: ab@email.com
                allowDuplicateRecords: 'false'
              memberStatus: Active
              createTransactionJournals: 'true'
              transactionJournalStatementFrequency: Monthly
              transactionJournalStatementMethod: Mail
              enrollmentChannel: Email
              canReceivePromotions: 'true'
              canReceivePartnerPromotions: 'true'
              membershipEndDate: '2022-01-01T00:00:00.000Z'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 May 2024 15:39:01 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/IndividualMemberEnrollments'
                - examples:
                  - contactId: 003J8000002Yu0Z
                    loyaltyProgramMemberId: 0lMJ8000000CaRM
                    loyaltyProgramName: NTO Insider
                    membershipNumber: Member1
                    transactionJournals:
                    - activityDate: '2020-12-31T23:00:00.000Z'
                      journalSubType: Member Enrollment
                      journalType: Accrual
                      loyaltyProgram: NTO Insider
                      loyaltyProgramMember: Member1
                      referredMember: null
                      status: Processed
                      transactionJournalId: 0lVJ8000000GmaJ
                contentMediaType: application/json;charset=UTF-8
              example:
                contactId: 003J8000002Yu0Z
                loyaltyProgramMemberId: 0lMJ8000000CaRM
                loyaltyProgramName: NTO Insider
                membershipNumber: Member1
                transactionJournals:
                - activityDate: '2020-12-31T23:00:00.000Z'
                  journalSubType: Member Enrollment
                  journalType: Accrual
                  loyaltyProgram: NTO Insider
                  loyaltyProgramMember: Member1
                  referredMember: null
                  status: Processed
                  transactionJournalId: 0lVJ8000000GmaJ
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    AssociatedContactDetails:
      title: AssociatedContactDetails
      required:
      - firstName
      - lastName
      - email
      - allowDuplicateRecords
      type: object
      properties:
        firstName:
          type: string
          example: example_value
        lastName:
          type: string
          example: example_value
        email:
          type: string
          example: user@example.com
        allowDuplicateRecords:
          type: string
          example: example_value
      examples:
      - firstName: Name1
        lastName: Name2
        email: ab@email.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
    IndividualMemberEnrollments:
      title: IndividualMemberEnrollments
      required:
      - contactId
      - loyaltyProgramMemberId
      - loyaltyProgramName
      - membershipNumber
      - transactionJournals
      type: object
      properties:
        contactId:
          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:
      - contactId: 003J8000002Yu0Z
        loyaltyProgramMemberId: 0lMJ8000000CaRM
        loyaltyProgramName: NTO Insider
        membershipNumber: Member1
        transactionJournals:
        - activityDate: '2020-12-31T23:00:00.000Z'
          journalSubType: Member Enrollment
          journalType: Accrual
          loyaltyProgram: NTO Insider
          loyaltyProgramMember: Member1
          referredMember: null
          status: Processed
          transactionJournalId: 0lVJ8000000GmaJ
    IndividualMemberEnrollmentsRequest:
      title: IndividualMemberEnrollmentsRequest
      required:
      - enrollmentDate
      - membershipNumber
      - associatedContactDetails
      - memberStatus
      - createTransactionJournals
      - transactionJournalStatementFrequency
      - transactionJournalStatementMethod
      - enrollmentChannel
      - canReceivePromotions
      - canReceivePartnerPromotions
      - membershipEndDate
      type: object
      properties:
        enrollmentDate:
          type: string
          example: example_value
        membershipNumber:
          type: string
          example: example_value
        associatedContactDetails:
          $ref: '#/components/schemas/AssociatedContactDetails'
        memberStatus:
          type: string
          example: example_value
        createTransactionJournals:
          type: string
          example: example_value
        transactionJournalStatementFrequency:
          type: string
          example: example_value
        transactionJournalStatementMethod:
          type: string
          example: example_value
        enrollmentChannel:
          type: string
          example: example_value
        canReceivePromotions:
          type: string
          example: example_value
        canReceivePartnerPromotions:
          type: string
          example: example_value
        membershipEndDate:
          type: string
          example: example_value
      examples:
      - enrollmentDate: '2021-01-01T00:00:00.000Z'
        membershipNumber: Member1
        associatedContactDetails:
          firstName: Name1
          lastName: Name2
          email: ab@email.com
          allowDuplicateRecords: 'false'
        memberStatus: Active
        createTransactionJournals: 'true'
        transactionJournalStatementFrequency: Monthly
        transactionJournalStatementMethod: Mail
        enrollmentChannel: Email
        canReceivePromotions: 'true'
        canReceivePartnerPromotions: 'true'
        membershipEndDate: '2022-01-01T00:00:00.000Z'
  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}".

        '