openapi: 3.2.0
info:
  title: ClickFunnels Communities::Ban 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::Ban
  description: '> Bans prevent a Contact from accessing a Community.


    A Ban records which Contact is banned, who issued the ban, the scope of the ban (`bannable_type`/`bannable_id`), and an optional reason. The `banned_by` moderator is set automatically to the acting user — it cannot be set in the request body. Bans have no update operation — delete and recreate to change the reason.


    See also: `Communities::Bans::UnbanAction` and `Communities::Bans::ExportAction` for async bulk operations on bans.

    '
paths:
  /communities/{community_id}/bans:
    get:
      tags:
      - Communities::Ban
      summary: List Bans
      description: List bans for a community
      operationId: listCommunitiesBans
      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/CommunitiesBanAttributes'
              example:
              - id: 201
                public_id: MnOpQr
                community_id: 1
                bannable_type: Community
                bannable_id: 1
                banned_by_id: 12
                reason: Violated community guidelines
                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: 202
                public_id: StUvWx
                community_id: 1
                bannable_type: Community
                bannable_id: 1
                banned_by_id: 12
                reason: null
                created_at: '2025-01-02T00:00:00.000Z'
                updated_at: '2025-01-02T00:00:00.000Z'
                contact:
                  id: 58
                  public_id: YzAbCd
                  email_address: spammer@example.com
                  first_name: Sam
                  last_name: Jones
                  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::Ban
      summary: Create Ban
      description: Ban a contact from a community
      operationId: createCommunitiesBans
      parameters:
      - name: community_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about the new Ban
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                communities_ban:
                  type: object
                  $ref: '#/components/schemas/CommunitiesBanParameters'
            example:
              communities_ban:
                contact_id: GhIjKl
                reason: Violated community guidelines
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesBanAttributes'
              example:
                id: 203
                public_id: EfGhIj
                community_id: 1
                bannable_type: Community
                bannable_id: 1
                banned_by_id: 12
                reason: Spam
                created_at: '2025-01-03T00:00:00.000Z'
                updated_at: '2025-01-03T00:00:00.000Z'
                contact:
                  id: 59
                  public_id: KlMnOp
                  email_address: spammer@example.com
                  first_name: Sam
                  last_name: Jones
                  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 been banned from this community
  /communities/bans/{id}:
    get:
      tags:
      - Communities::Ban
      summary: Fetch Ban
      description: Retrieve a community ban
      operationId: getCommunitiesBans
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunitiesBanAttributes'
              example:
                id: 201
                public_id: MnOpQr
                community_id: 1
                bannable_type: Community
                bannable_id: 1
                banned_by_id: 12
                reason: Violated community guidelines
                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'
    delete:
      tags:
      - Communities::Ban
      summary: Remove Ban
      description: Unban a contact from a community
      operationId: removeCommunitiesBans
      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:
    CommunitiesBanAttributes:
      type: object
      title: Communities::Ban
      description: Communities::Ban
      properties:
        id:
          type: integer
          description: Ban ID
        public_id:
          type:
          - string
          - 'null'
          description: Ban public ID
        community_id:
          type: integer
          description: ID of the Community this ban applies to
        bannable_type:
          type: string
          description: Polymorphic type of the bannable scope (e.g. Community)
        bannable_id:
          type: integer
          description: Polymorphic ID of the bannable scope
        banned_by_id:
          type: integer
          description: ID of the membership record that issued the ban (set automatically)
        reason:
          type:
          - string
          - 'null'
          description: Optional reason for the ban (max 1024 characters)
        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 banned 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: 201
        public_id: MnOpQr
        community_id: 1
        bannable_type: Community
        bannable_id: 1
        banned_by_id: 12
        reason: Violated community guidelines
        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:
      - bannable_id
      - bannable_type
      - banned_by_id
      - community_id
      - contact
      - created_at
      - id
      - public_id
      - reason
      - updated_at
    CommunitiesBanParameters:
      type: object
      title: Communities::Ban
      description: Communities::Ban
      required:
      - contact_id
      properties:
        contact_id:
          type: string
          description: Public ID of the Contact to ban
        reason:
          type:
          - string
          - 'null'
          description: Optional reason for the ban (max 1024 characters)
      example:
        communities_ban:
          contact_id: GhIjKl
          reason: Violated community guidelines
  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