ClickFunnels Communities::Membership API

openapi: 3.2.0
info:
  title: ClickFunnels Communities::Membership API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Communities::Membership
  description: '> Memberships represent a Contact''s membership in a Community.


    A Membership joins a Contact to a Community and tracks whether that member has moderator privileges. Creating or updating a membership also syncs the member''s Space memberships to exactly the list of `space_ids` supplied. Deleting a membership removes the contact from all Spaces in the community as well.


    See also: `Communities::Memberships::BanAction`, `Communities::Memberships::AddToGroupAction`, `Communities::Memberships::RemoveFromGroupAction`, and `Communities::Memberships::ExportAction` for async bulk operations on memberships.

    '
paths:
  /communities/{community_id}/memberships:
    get:
      tags:
      - Communities::Membership
      summary: List Memberships
      description: List memberships for a community
      operationId: listCommunitiesMemberships
      parameters:
      - name: community_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommunitiesMembershipAttributes'
              example:
              - id: 101
                public_id: AbCdEf
                community_id: 1
                moderator: false
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                contact:
                  id: 55
                  public_id: GhIjKl
                  email_address: member@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: null
              - id: 102
                public_id: MnOpQr
                community_id: 1
                moderator: true
                created_at: '2025-01-02T00:00:00.000Z'
                updated_at: '2025-01-02T00:00:00.000Z'
                contact:
                  id: 56
                  public_id: StUvWx
                  email_address: mod@example.com
                  first_name: John
                  last_name: Smith
                  phone_number: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Community parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Communities::Membership
      summary: Create Membership
      description: Add a contact as a member of a community
      operationId: createCommunitiesMemberships
      parameters:
      - name: community_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about the new Membership
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                communities_membership:
                  type: object
                  $ref: '#/components/schemas/CommunitiesMembershipParameters'
            example:
              communities_membership:
                contact_id: GhIjKl
                moderator: false
                space_ids:
                - SpAcEa
                - SpAcEb
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesMembershipAttributes'
              example:
                id: 103
                public_id: YzAbCd
                community_id: 1
                moderator: false
                created_at: '2025-01-03T00:00:00.000Z'
                updated_at: '2025-01-03T00:00:00.000Z'
                contact:
                  id: 57
                  public_id: EfGhIj
                  email_address: member@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: Contact has already joined this community
  /communities/memberships/{id}:
    get:
      tags:
      - Communities::Membership
      summary: Fetch Membership
      description: Retrieve a community membership
      operationId: getCommunitiesMemberships
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesMembershipAttributes'
              example:
                id: 101
                public_id: AbCdEf
                community_id: 1
                moderator: false
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                contact:
                  id: 55
                  public_id: GhIjKl
                  email_address: member@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: null
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Communities::Membership
      summary: Update Membership
      description: Update a community membership (e.g. moderator status or space memberships)
      operationId: updateCommunitiesMemberships
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Fields to update on the Membership
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                communities_membership:
                  type: object
                  $ref: '#/components/schemas/CommunitiesMembershipParametersUpdate'
            example:
              communities_membership:
                moderator: true
                space_ids:
                - SpAcEa
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesMembershipAttributes'
              example:
                id: 101
                public_id: AbCdEf
                community_id: 1
                moderator: true
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                contact:
                  id: 55
                  public_id: GhIjKl
                  email_address: member@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    delete:
      tags:
      - Communities::Membership
      summary: Remove Membership
      description: Remove a contact's membership from a community. This also removes the contact from all Spaces within the community.
      operationId: removeCommunitiesMemberships
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: 'Sort property of a list response. The default is id and thus the created_at order.

        If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  schemas:
    CommunitiesMembershipParameters:
      type: object
      title: Communities::Membership
      description: Communities::Membership
      required:
      - contact_id
      properties:
        contact_id:
          type: string
          description: Public ID of the Contact to add as a member
        moderator:
          type:
          - boolean
          - 'null'
          description: Whether this member should have moderator privileges
        space_ids:
          type:
          - array
          - 'null'
          description: 'Array of Space public IDs the member should belong to. The membership form syncs the member''s Space memberships to exactly this list — Spaces not in the list are removed, Spaces in the list are added.

            '
          items:
            type: string
      example:
        communities_membership:
          contact_id: GhIjKl
          moderator: false
          space_ids:
          - SpAcEa
          - SpAcEb
    CommunitiesMembershipParametersUpdate:
      type: object
      title: Communities::Membership
      description: Communities::Membership
      properties:
        moderator:
          type:
          - boolean
          - 'null'
          description: Whether this member should have moderator privileges
        space_ids:
          type:
          - array
          - 'null'
          description: 'Array of Space public IDs the member should belong to. The membership form syncs the member''s Space memberships to exactly this list — Spaces not in the list are removed, Spaces in the list are added.

            '
          items:
            type: string
      example:
        communities_membership:
          moderator: true
          space_ids:
          - SpAcEa
    CommunitiesMembershipAttributes:
      type: object
      title: Communities::Membership
      description: Communities::Membership
      properties:
        id:
          type: integer
          description: Membership ID
        public_id:
          type:
          - string
          - 'null'
          description: Membership public ID
        community_id:
          type: integer
          description: ID of the Community this membership belongs to
        moderator:
          type:
          - boolean
          - 'null'
          description: Whether this member has moderator privileges in the community
        created_at:
          type: string
          format: date-time
          description: Created at
        updated_at:
          type: string
          format: date-time
          description: Updated at
        contact:
          type:
          - object
          - 'null'
          description: The member Contact (null if the contact has been removed)
          properties:
            id:
              type: integer
              description: Contact ID
            public_id:
              type:
              - string
              - 'null'
              description: Contact public ID
            email_address:
              type:
              - string
              - 'null'
              description: Contact email address
            first_name:
              type:
              - string
              - 'null'
              description: Contact first name
            last_name:
              type:
              - string
              - 'null'
              description: Contact last name
            phone_number:
              type:
              - string
              - 'null'
              description: Contact phone number
      example:
        id: 101
        public_id: AbCdEf
        community_id: 1
        moderator: false
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
        contact:
          id: 55
          public_id: GhIjKl
          email_address: member@example.com
          first_name: Jane
          last_name: Doe
          phone_number: null
      required:
      - community_id
      - contact
      - created_at
      - id
      - moderator
      - public_id
      - updated_at
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com