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

# Update an app instance



## OpenAPI

````yaml /openapi.yaml patch /workspaces/{workspace}/apps/{app}
openapi: 3.1.0
info:
  title: Contact Button API
  version: 1.0.0-alpha.1
  description: >
    API-first management and public agent actions for Contact Buttons and
    button.contact pages.

    API v1 is the first public contract. Existing private legacy API and browser
    workflows remain supported.
  contact:
    name: Contact Button
    url: https://learn.contactbutton.com
servers:
  - url: https://api.contactbutton.com/v1
    description: Production (canonical)
  - url: https://app.contactbutton.com/v1
    description: Backwards-compatible application-domain alias
security:
  - bearerAuth: []
tags:
  - name: Onboarding
    description: Human-verified agent onboarding.
  - name: Workspaces
  - name: Team
  - name: Pages
  - name: Domains
  - name: Buttons
  - name: Forms
  - name: Surveys
  - name: Apps
  - name: Knowledge
  - name: Booking
  - name: Telephony
    description: >-
      Bring-your-own-Telnyx setup, call flows, phone numbers, and voice
      interactions.
  - name: Reviews
    description: >-
      Send consented review requests through workspace-owned email, SMS, and
      WhatsApp channels.
  - name: Commerce
  - name: Engagement inbox
  - name: Public actions
    description: Public, rate-limited actions that may require human confirmation.
paths:
  /workspaces/{workspace}/apps/{app}:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - $ref: '#/components/parameters/AppId'
    patch:
      tags:
        - Apps
      summary: Update an app instance
      operationId: updateApp
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppInput'
      responses:
        '200':
          $ref: '#/components/responses/Data'
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
        format: uuid
    AppId:
      name: app
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    AppInput:
      type: object
      properties:
        catalog_slug:
          type: string
        title:
          type: string
        fields:
          type: object
          additionalProperties: true
        desktop:
          type: boolean
        tablet:
          type: boolean
          description: >-
            Visible from 768px through 1023px. Defaults to mobile for legacy
            payloads.
        mobile:
          type: boolean
        visibility:
          $ref: '#/components/schemas/DeviceVisibility'
        status:
          type: boolean
        resource_type:
          type:
            - string
            - 'null'
          enum:
            - form
            - list
            - null
        resource_id:
          type:
            - string
            - 'null'
          format: uuid
    DeviceVisibility:
      type: object
      required:
        - desktop
        - tablet
        - mobile
      additionalProperties: false
      description: >-
        Viewport visibility using mobile below 768px, tablet from 768px through
        1023px, and desktop at 1024px or wider.
      properties:
        desktop:
          type: boolean
        tablet:
          type: boolean
        mobile:
          type: boolean
    DataResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data: {}
        meta:
          type: object
          properties:
            request_id:
              type: string
            next_cursor:
              type:
                - string
                - 'null'
  responses:
    Data:
      description: Successful data envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DataResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum personal access token
      description: >
        A Contact Button scoped bearer key. Send `Authorization: Bearer
        <token>`.

        Token abilities are enforced independently of workspace membership; both
        checks must pass.

        OAuth 2.0 authorization-code flows are not currently available.
      x-contact-button-token-abilities:
        workspaces:read: Read workspaces, teams, domains, settings, and connections.
        workspaces:write: >-
          Create and manage workspaces, teams, domains, settings, and
          connections.
        content:read: Read buttons, forms, lists, pages, booking types, and knowledge.
        content:write: Create, update, publish, and remove content.
        engagements:read: >-
          Read submissions, subscribers, bookings, callbacks, calls, reviews,
          and conversations.
        engagements:manage: Reply to and manage engagement records.
        actions:request: Request protected actions that can still require human confirmation.

````

## Related topics

- [Update an app instance (PUT compatibility)](/api-reference/apps/update-an-app-instance-put-compatibility.md)
- [Get an app instance](/api-reference/apps/get-an-app-instance.md)
- [Create an app instance](/api-reference/apps/create-an-app-instance.md)
- [Delete an unused app instance](/api-reference/apps/delete-an-unused-app-instance.md)
- [Update a button](/api-reference/buttons/update-a-button.md)