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

# Patch Deployment

> Apply a [JSON Patch](https://jsonpatch.com/) array to the deployment document.

Send the `ETag` from GET as `If-Match` for optimistic concurrency.


<Info>
  For AI agents, use `https://docs.tavus.io/openapi.yaml` for the full HTTP API contract.
</Info>


## OpenAPI

````yaml patch /v2/deployments/{deployment_id}
openapi: 3.0.3
info:
  title: Tavus Developer API Collection
  version: 1.0.0
  contact: {}
servers:
  - url: https://tavusapi.com
security:
  - apiKey: []
tags:
  - name: Videos
  - name: Faces
  - name: Voices
  - name: Conversations
  - name: Deployments
  - name: PALs
  - name: Tools
  - name: PAL Tools
  - name: Pronunciation Dictionaries
  - name: Replacements
  - name: Transcriptions
  - name: Documents
paths:
  /v2/deployments/{deployment_id}:
    patch:
      tags:
        - Deployments
      summary: Patch Deployment
      description: >
        Apply a [JSON Patch](https://jsonpatch.com/) array to the deployment
        document.


        Send the `ETag` from GET as `If-Match` for optimistic concurrency.
      operationId: patchDeployment
      parameters:
        - name: deployment_id
          in: path
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          required: false
          schema:
            type: string
          description: ETag from a prior GET response.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
              example:
                - op: replace
                  path: /name
                  value: Support widget
      responses:
        '200':
          description: Updated deployment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment'
        '401':
          description: UNAUTHORIZED
        '404':
          description: Not Found
        '422':
          description: Invalid JSON Patch
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid JSON patch format
      security:
        - apiKey: []
components:
  schemas:
    deployment:
      type: object
      description: >-
        A managed deployment. See [Deployments
        overview](/sections/deployments/overview).
      properties:
        deployment_id:
          type: string
          example: d1234567890abcdef
        pal_id:
          type: string
          description: PAL that powers the deployment.
          example: pcb7a34da5fe
        channel:
          type: string
          enum:
            - widget
            - embed
            - landing-page
        status:
          type: string
          enum:
            - draft
            - active
            - inactive
        name:
          type: string
        has_password:
          type: boolean
        customization:
          type: object
        replica_thumbnail_video_url:
          type: string
          nullable: true
          deprecated: true
          description: >-
            **Removed.** Use `thumbnail_video_url` and `thumbnail_image_url`
            instead.
        thumbnail_video_url:
          type: string
          nullable: true
          description: URL for the face preview video thumbnail.
        thumbnail_image_url:
          type: string
          nullable: true
          description: URL for the face preview image thumbnail.
        limits:
          type: object
        allowed_origins:
          type: array
          items:
            type: string
        usage_total:
          type: integer
        usage_today:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````