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

# Update a pixel (pause, activate, or set path filters)

> Updates a pixel. Accepts status, excludedPaths, includedPaths, or any combination. Set paths to null to clear. Mutually exclusive: cannot have both includedPaths and excludedPaths set. Authenticates via X-API-Key header.



## OpenAPI

````yaml https://api.aws53.cloud/openapi-data.json patch /v1/data/pixels/{id}
openapi: 3.1.0
info:
  title: Identification API
  version: 1.0.0
  description: >-
    Programmatic access to your visitor data and pixel management. Authenticate
    with your API key (X-API-Key header).
servers:
  - url: https://api.aws53.cloud
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Visitors
  - name: Pixels
  - name: Account
paths:
  /v1/data/pixels/{id}:
    patch:
      tags:
        - Pixels
      summary: Update a pixel (pause, activate, or set path filters)
      description: >-
        Updates a pixel. Accepts status, excludedPaths, includedPaths, or any
        combination. Set paths to null to clear. Mutually exclusive: cannot have
        both includedPaths and excludedPaths set. Authenticates via X-API-Key
        header.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - active
                    - paused
                  example: paused
                excludedPaths:
                  type:
                    - array
                    - 'null'
                  items:
                    type: string
                    minLength: 2
                    maxLength: 500
                    pattern: ^\/
                  maxItems: 50
                  description: >-
                    Denylist: URL path prefixes where tracking is skipped.
                    Mutually exclusive with includedPaths.
                  example:
                    - /blog
                    - /careers
                includedPaths:
                  type:
                    - array
                    - 'null'
                  items:
                    type: string
                    minLength: 2
                    maxLength: 500
                    pattern: ^\/
                  maxItems: 50
                  description: >-
                    Allowlist: if set, tracking fires ONLY on matching path
                    prefixes. Mutually exclusive with excludedPaths.
                  example:
                    - /pricing
                    - /demo
      responses:
        '200':
          description: Pixel updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixelUpdated'
        '400':
          description: Validation error (e.g. both includedPaths and excludedPaths set)
        '401':
          description: Missing or invalid API key
        '403':
          description: Cannot activate pixel for inactive org
        '404':
          description: Pixel not found
      security:
        - apiKeyAuth: []
components:
  schemas:
    PixelUpdated:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            domain:
              type: string
            name:
              type: string
            status:
              type: string
            excludedPaths:
              type:
                - array
                - 'null'
              items:
                type: string
            includedPaths:
              type:
                - array
                - 'null'
              items:
                type: string
            updatedAt:
              type: string
          required:
            - id
            - domain
            - name
            - status
            - excludedPaths
            - includedPaths
            - updatedAt
      required:
        - data
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Organization API key (sk_...). Get yours from Settings > API Keys in the
        dashboard.

````