Salesforce Memberships API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Memberships 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: Memberships
paths:
  /data/v64.0/chatter/group-membership-requests/{CHATTER_GROUP_REQUEST_ID}:
    parameters: []
    patch:
      tags:
      - Memberships
      summary: Salesforce Group Membership Requests—private
      description: 'Update the status of a request by a user to join a private group or get information about a request to join a private group.


        https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_group_membership_requests.htm?search_text=group-membership-requests'
      operationId: GroupMembershipRequests—Private
      parameters:
      - name: status
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Accepted
        example: example_value
      - name: responseMessage
        in: query
        description: ''
        required: true
        style: form
        explode: true
        schema:
          type: string
          examples:
          - Welcome to the group!
        example: example_value
      - name: CHATTER_GROUP_REQUEST_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Wed, 22 Nov 2023 11:50:19 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
            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
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulGroupMembershipRequestsPrivate'
                - examples:
                  - createdDate: '2023-11-22T11:46:32.000Z'
                    id: 0I5...
                    lastUpdateDate: '2023-11-22T11:50:19.000Z'
                    requestedGroup:
                      id: 0F9...
                      url: /services/data/v58.0/chatter/groups/0F9...
                    responseMessage: null
                    status: Accepted
                    url: /services/data/v58.0/chatter/group-membership-requests/0I5...
                    user:
                      additionalLabel: null
                      communityNickname: User1700653511864742682
                      companyName: null
                      displayName: User Sample
                      firstName: User
                      id: 005...
                      isActive: true
                      isInThisCommunity: true
                      lastName: Sample
                      motif:
                        color: 1B96FF
                        largeIconUrl: /img/icon/profile64.png
                        mediumIconUrl: /img/icon/profile32.png
                        smallIconUrl: /img/icon/profile16.png
                        svgIconUrl: null
                      mySubscription: null
                      name: User Sample
                      outOfOffice:
                        message: ''
                      photo:
                        fullEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1
                        largePhotoUrl: https://<my_domain>/profilephoto/005/F
                        mediumPhotoUrl: https://<my_domain>/profilephoto/005/M
                        photoVersionId: null
                        smallPhotoUrl: https://<my_domain>/profilephoto/005/T
                        standardEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1
                        url: /services/data/v58.0/connect/user-profiles/005.../photo
                      reputation: null
                      title: null
                      type: User
                      url: /services/data/v58.0/chatter/users/005...
                      userType: Internal
                contentMediaType: application/json;charset=UTF-8
              example:
                createdDate: '2023-11-22T11:46:32.000Z'
                id: 0I5...
                lastUpdateDate: '2023-11-22T11:50:19.000Z'
                requestedGroup:
                  id: 0F9...
                  url: /services/data/v58.0/chatter/groups/0F9...
                responseMessage: null
                status: Accepted
                url: /services/data/v58.0/chatter/group-membership-requests/0I5...
                user:
                  additionalLabel: null
                  communityNickname: User1700653511864742682
                  companyName: null
                  displayName: User Sample
                  firstName: User
                  id: 005...
                  isActive: true
                  isInThisCommunity: true
                  lastName: Sample
                  motif:
                    color: 1B96FF
                    largeIconUrl: /img/icon/profile64.png
                    mediumIconUrl: /img/icon/profile32.png
                    smallIconUrl: /img/icon/profile16.png
                    svgIconUrl: null
                  mySubscription: null
                  name: User Sample
                  outOfOffice:
                    message: ''
                  photo:
                    fullEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1
                    largePhotoUrl: https://<my_domain>/profilephoto/005/F
                    mediumPhotoUrl: https://<my_domain>/profilephoto/005/M
                    photoVersionId: null
                    smallPhotoUrl: https://<my_domain>/profilephoto/005/T
                    standardEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1
                    url: /services/data/v58.0/connect/user-profiles/005.../photo
                  reputation: null
                  title: null
                  type: User
                  url: /services/data/v58.0/chatter/users/005...
                  userType: Internal
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    SuccessfulGroupMembershipRequestsPrivate:
      title: SuccessfulGroupMembershipRequestsPrivate
      required:
      - createdDate
      - id
      - lastUpdateDate
      - requestedGroup
      - responseMessage
      - status
      - url
      - user
      type: object
      properties:
        createdDate:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        lastUpdateDate:
          type: string
          example: example_value
        requestedGroup:
          $ref: '#/components/schemas/RequestedGroup'
        responseMessage:
          type:
          - string
          - 'null'
          example: example_value
        status:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
        user:
          $ref: '#/components/schemas/User3'
      examples:
      - createdDate: '2023-11-22T11:46:32.000Z'
        id: 0I5...
        lastUpdateDate: '2023-11-22T11:50:19.000Z'
        requestedGroup:
          id: 0F9...
          url: /services/data/v58.0/chatter/groups/0F9...
        responseMessage: null
        status: Accepted
        url: /services/data/v58.0/chatter/group-membership-requests/0I5...
        user:
          additionalLabel: null
          communityNickname: User1700653511864742682
          companyName: null
          displayName: User Sample
          firstName: User
          id: 005...
          isActive: true
          isInThisCommunity: true
          lastName: Sample
          motif:
            color: 1B96FF
            largeIconUrl: /img/icon/profile64.png
            mediumIconUrl: /img/icon/profile32.png
            smallIconUrl: /img/icon/profile16.png
            svgIconUrl: null
          mySubscription: null
          name: User Sample
          outOfOffice:
            message: ''
          photo:
            fullEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1
            largePhotoUrl: https://<my_domain>/profilephoto/005/F
            mediumPhotoUrl: https://<my_domain>/profilephoto/005/M
            photoVersionId: null
            smallPhotoUrl: https://<my_domain>/profilephoto/005/T
            standardEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1
            url: /services/data/v58.0/connect/user-profiles/005.../photo
          reputation: null
          title: null
          type: User
          url: /services/data/v58.0/chatter/users/005...
          userType: Internal
    User3:
      title: User3
      required:
      - additionalLabel
      - communityNickname
      - companyName
      - displayName
      - firstName
      - id
      - isActive
      - isInThisCommunity
      - lastName
      - motif
      - mySubscription
      - name
      - outOfOffice
      - photo
      - reputation
      - title
      - type
      - url
      - userType
      type: object
      properties:
        additionalLabel:
          type:
          - string
          - 'null'
          example: example_value
        communityNickname:
          type: string
          example: example_value
        companyName:
          type:
          - string
          - 'null'
          example: example_value
        displayName:
          type: string
          example: example_value
        firstName:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        isActive:
          type: boolean
          example: true
        isInThisCommunity:
          type: boolean
          example: true
        lastName:
          type: string
          example: example_value
        motif:
          $ref: '#/components/schemas/Motif'
        mySubscription:
          type:
          - string
          - 'null'
          example: example_value
        name:
          type: string
          example: Example Title
        outOfOffice:
          $ref: '#/components/schemas/OutOfOffice'
        photo:
          $ref: '#/components/schemas/Photo15'
        reputation:
          type:
          - string
          - 'null'
          example: example_value
        title:
          type:
          - string
          - 'null'
          example: Example Title
        type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
        userType:
          type: string
          example: example_value
      examples:
      - additionalLabel: null
        communityNickname: User1700653511864742682
        companyName: null
        displayName: User Sample
        firstName: User
        id: 005...
        isActive: true
        isInThisCommunity: true
        lastName: Sample
        motif:
          color: 1B96FF
          largeIconUrl: /img/icon/profile64.png
          mediumIconUrl: /img/icon/profile32.png
          smallIconUrl: /img/icon/profile16.png
          svgIconUrl: null
        mySubscription: null
        name: User Sample
        outOfOffice:
          message: ''
        photo:
          fullEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1
          largePhotoUrl: https://<my_domain>/profilephoto/005/F
          mediumPhotoUrl: https://<my_domain>/profilephoto/005/M
          photoVersionId: null
          smallPhotoUrl: https://<my_domain>/profilephoto/005/T
          standardEmailPhotoUrl: https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1
          url: /services/data/v58.0/connect/user-profiles/005.../photo
        reputation: null
        title: null
        type: User
        url: /services/data/v58.0/chatter/users/005...
        userType: Internal
    RequestedGroup:
      title: RequestedGroup
      required:
      - id
      - url
      type: object
      properties:
        id:
          type: string
          example: abc123
        url:
          type: string
          example: https://www.example.com
      examples:
      - id: 0F9...
        url: /services/data/v58.0/chatter/groups/0F9...
    Photo15:
      title: Photo15
      required:
      - fullEmailPhotoUrl
      - largePhotoUrl
      - mediumPhotoUrl
      - photoVersionId
      - smallPhotoUrl
      - standardEmailPhotoUrl
      - url
      type: object
      properties:
        fullEmailPhotoUrl:
          type: string
          example: user@example.com
        largePhotoUrl:
          type: string
          example: https://www.example.com
        mediumPhotoUrl:
          type: string
          example: https://www.example.com
        photoVersionId:
          type:
          - string
          - 'null'
          example: '500123'
        smallPhotoUrl:
          type: string
          example: https://www.example.com
        standardEmailPhotoUrl:
          type: string
          example: user@example.com
        url:
          type: string
          example: https://www.example.com
      examples:
      - fullEmailPhotoUrl: https://<my_domain>/img/userprofile/default_group_profile_200_v2.png?fromEmail=1
        largePhotoUrl: https://<my_domain>/profilephoto/0F9/F
        mediumPhotoUrl: https://<my_domain>/profilephoto/0F9/M
        photoVersionId: null
        smallPhotoUrl: https://<my_domain>/profilephoto/0F9/T
        standardEmailPhotoUrl: https://<my_domain>/img/userprofile/default_group_profile_45_v2.png?fromEmail=1
        url: /services/data/v58.0/chatter/groups/0F9.../photo
    Motif:
      title: Motif
      required:
      - color
      - largeIconUrl
      - mediumIconUrl
      - smallIconUrl
      - svgIconUrl
      type: object
      properties:
        color:
          type: string
          example: example_value
        largeIconUrl:
          type: string
          example: https://www.example.com
        mediumIconUrl:
          type: string
          example: https://www.example.com
        smallIconUrl:
          type: string
          example: https://www.example.com
        svgIconUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
      examples:
      - color: '939393'
        largeIconUrl: /img/content/content64.png
        mediumIconUrl: /img/content/content32.png
        smallIconUrl: /img/icon/files16.png
        svgIconUrl: null
    OutOfOffice:
      title: OutOfOffice
      required:
      - message
      type: object
      properties:
        message:
          type: string
          example: example_value
      examples:
      - message: ''
  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}".

        '