> ## Documentation Index
> Fetch the complete documentation index at: https://bulkgrid.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update collection rules

> Required permission: collections:write.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/collections/{collectionId}/rules
openapi: 3.0.3
info:
  title: Bulkgrid API
  version: 0.1.0
  description: >-
    Search indexed content, create crawl and extraction runs, and retrieve
    results. API keys require the scopes listed for each operation. OAuth
    connections grant MCP and search access only.
servers:
  - url: https://bulkgrid.com
    description: Bulkgrid
security:
  - apiKeyAuth: []
  - bearerAuth: []
tags:
  - name: Sources
    description: Source discovery, subscriptions, and indexing
  - name: Collections
    description: Collections and content selection rules
  - name: Search
    description: Search endpoints
  - name: Runs
    description: Run creation and lifecycle endpoints
  - name: Results
    description: Run result retrieval endpoints
paths:
  /api/v1/collections/{collectionId}/rules:
    patch:
      tags:
        - Collections
      summary: Update collection rules
      description: 'Required permission: collections:write.'
      operationId: collectionsUpdateRules
      parameters:
        - name: collectionId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                add:
                  default: []
                  type: array
                  items:
                    type: object
                    properties:
                      action:
                        type: string
                        enum:
                          - include
                          - exclude
                      target:
                        type: string
                        enum:
                          - source
                          - folder
                          - url
                      source_id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      target_id:
                        type: string
                        minLength: 1
                      metadata: {}
                    required:
                      - action
                      - target
                      - source_id
                      - target_id
                remove:
                  default: []
                  type: array
                  items:
                    type: object
                    properties:
                      action:
                        type: string
                        enum:
                          - include
                          - exclude
                      target:
                        type: string
                        enum:
                          - source
                          - folder
                          - url
                      source_id:
                        type: string
                        format: uuid
                        pattern: >-
                          ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                      target_id:
                        type: string
                        minLength: 1
                      metadata: {}
                    required:
                      - action
                      - target
                      - source_id
                      - target_id
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rules:
                    type: array
                    items:
                      type: object
                      properties:
                        action:
                          type: string
                          enum:
                            - include
                            - exclude
                        target:
                          type: string
                          enum:
                            - source
                            - folder
                            - url
                        source_id:
                          type: string
                        target_id:
                          type: string
                        metadata: {}
                      required:
                        - action
                        - target
                        - source_id
                        - target_id
                      additionalProperties: {}
                  counts:
                    nullable: true
                    type: object
                    properties:
                      sources:
                        type: number
                      folders:
                        type: number
                      urls_selected:
                        type: number
                      urls_excluded:
                        type: number
                      urls_effective:
                        type: number
                    required:
                      - sources
                      - folders
                      - urls_selected
                      - urls_excluded
                      - urls_effective
                    additionalProperties: false
                  countsBySource:
                    type: object
                    additionalProperties:
                      type: number
                required:
                  - rules
                  - counts
                  - countsBySource
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details: {}
                required:
                  - error
                additionalProperties: false
      security:
        - apiKeyAuth: []
        - bearerAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Bulkgrid API key
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bulkgrid API key or OAuth access token. OAuth grants currently allow
        search:query and mcp:use only.

````