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

# Preview an endpoint update

> Test an endpoint against the canonical version to see the updated behavior before merging. Returns the execution result plus sample inputs.



## OpenAPI

````yaml /openapi.json post /dispatch/tasks/{task_id}/preview-update/{endpoint_name}
openapi: 3.1.0
info:
  title: Parse API
  description: Programmatic API for creating, managing, and executing web scraping APIs.
  version: 2.0.0
servers:
  - url: https://api.parse.bot
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Execute
    description: Call the endpoints of an API you've built — the most common operation
  - name: Marketplace
    description: >-
      Browse and search the public marketplace of pre-built APIs (no auth
      required)
  - name: Dispatch
    description: Create and manage scraping APIs
  - name: Export
    description: Export API specs in standard formats
  - name: Updates
    description: Check and merge upstream improvements to your APIs
paths:
  /dispatch/tasks/{task_id}/preview-update/{endpoint_name}:
    post:
      tags:
        - Dispatch
      summary: Preview an endpoint update
      description: >-
        Test an endpoint against the canonical version to see the updated
        behavior before merging. Returns the execution result plus sample
        inputs.
      operationId: preview_update
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
        - name: endpoint_name
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                params:
                  type: object
                  additionalProperties: true
                  description: Test parameters for the endpoint
      responses:
        '200':
          description: Execution result from the canonical version
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    nullable: true
                  sample_inputs:
                    type: object
                    description: Pre-fill data from canonical for this endpoint
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for programmatic access. Create one in the Parse dashboard at
        https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.

````