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

# Update an endpoint

> Change an endpoint's settings, or take it offline with `is_active: false`. The slug and the backing scraper cannot be changed — create a new endpoint for that.

Requires the `write` permission.



## OpenAPI

````yaml PATCH /api/endpoints/{id}
openapi: 3.1.0
info:
  title: ManyPI API
  description: >-
    The REST API behind ManyPI — AI lead generation, email validation,
    cold-email outreach, agent runs and web scraping. Every endpoint is
    authenticated with a ManyPI API key (`mpi_...`) or an OAuth 2.1 access
    token, and honours the permissions granted to that credential.
  version: 2.0.0
  contact:
    name: ManyPI Support
    email: support@manypi.com
    url: https://manypi.com
servers:
  - url: https://app.manypi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Leads
    description: Find, store, enrich and manage leads.
  - name: Email validation
    description: Verify that lead addresses can receive mail.
  - name: Outreach
    description: Inboxes, sequences, campaigns, sending and replies.
  - name: Agent
    description: Agent runs, replies and skills.
  - name: Scraping
    description: Scrapers, runs and extracted data.
  - name: Endpoints
    description: Publish scrapers as typed REST endpoints.
  - name: Account
    description: Key validation and account information.
paths:
  /api/endpoints/{id}:
    patch:
      tags:
        - Endpoints
      summary: Update an API endpoint
      description: >-
        Change an endpoint's settings, or take it offline with `is_active:
        false`. The slug and the backing scraper cannot be changed — create a
        new endpoint for that.


        Requires the `write` permission.
      operationId: updateEndpoint
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 120
                description:
                  type: string
                  maxLength: 2000
                  nullable: true
                method:
                  type: string
                  enum:
                    - GET
                    - POST
                param_schema:
                  type: object
                  nullable: true
                output_schema:
                  type: object
                  nullable: true
                freshness:
                  type: string
                  enum:
                    - cached_ok
                    - always_fresh
                cache_ttl_seconds:
                  type: integer
                  minimum: 0
                  maximum: 604800
                mode:
                  type: string
                  enum:
                    - sync
                    - async
                is_active:
                  type: boolean
                  description: >-
                    `false` takes the endpoint offline: calls to its URL return
                    `404` until it is turned back on.
            example:
              cache_ttl_seconds: 900
              freshness: cached_ok
      responses:
        '200':
          description: The updated endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Endpoint:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        method:
          type: string
          enum:
            - GET
            - POST
        scraper_id:
          type: string
          format: uuid
        param_schema:
          type: object
          nullable: true
        output_schema:
          type: object
          nullable: true
        freshness:
          type: string
          enum:
            - cached_ok
            - always_fresh
        cache_ttl_seconds:
          type: integer
        mode:
          type: string
          enum:
            - sync
            - async
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          description: >-
            Human-readable message. A few validation failures (creating or
            updating an endpoint, bulk lead updates and deletes) send a list of
            the individual problems here instead of one string.
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                properties:
                  path:
                    type: array
                    items:
                      type:
                        - string
                        - integer
                  message:
                    type: string
        code:
          type: string
          description: >-
            A machine-readable code on gated failures: `lead_limit`,
            `outreach_locked`, `validation_credits_exhausted`.
        details:
          description: >-
            Extra detail on some failures, such as the list of parameters that
            failed an endpoint's `param_schema`.
  responses:
    BadRequest:
      description: The request body or parameters failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing, invalid or expired credential — or a key that lacks the
        permission this route requires.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A ManyPI API key (`mpi_...`) from the profile menu → API Access in the
        dashboard, or an OAuth 2.1 access token obtained through the MCP consent
        flow.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.