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

# SetVoiceWidgetStatusAPI turns a website concierge widget on or off. It is the


> widget's counterpart to disabling a capture pipeline (PUT /v1/event-pipelines/:pipelineSlug with state=disabled), so a system that governs a customer's commercial state can quiet both governed public surfaces through the product API instead of Erdo refusing work inline.

The widget is named by its public key (vw\_...) or its name, url-encoded into the path; only the status changes, and every other setting is preserved.




## OpenAPI

````yaml /api/openapi.json post /v1/voice/widgets/{widget}/status
openapi: 3.0.0
info:
  title: Erdo API
  description: >-
    Erdo's REST API: query and write datasets, run agents, manage threads,
    integrations, pages, evals, workstreams, experiments, and bounded outreach.
    Authenticate with a Bearer API key (erdo_api_...) or scoped token
    (erdo_token_...).
  version: '2026-09-09'
servers:
  - url: https://api.erdo.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/voice/widgets/{widget}/status:
    post:
      summary: >
        SetVoiceWidgetStatusAPI turns a website concierge widget on or off. It
        is the
      description: >
        widget's counterpart to disabling a capture pipeline (PUT
        /v1/event-pipelines/:pipelineSlug with state=disabled), so a system that
        governs a customer's commercial state can quiet both governed public
        surfaces through the product API instead of Erdo refusing work inline.


        The widget is named by its public key (vw\_...) or its name, url-encoded
        into the path; only the status changes, and every other setting is
        preserved.
      operationId: POST:mcp.SetVoiceWidgetStatusAPI
      parameters:
        - allowEmptyValue: true
          explode: false
          in: path
          name: widget
          required: true
          schema:
            type: string
          style: simple
      requestBody:
        content:
          application/json:
            schema:
              properties:
                status:
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  name:
                    type: string
                  serving:
                    description: >
                      active AND fully provisioned. A widget that was never
                      finished provisioning reads active but not serving, so a
                      caller enabling one can tell the difference between "on"
                      and "working".
                    title: >
                      Serving is whether visitors can actually start a
                      conversation right now —
                    type: boolean
                  status:
                    title: >
                      Status is the stored lifecycle state: "active" or
                      "disabled".
                    type: string
                  updated_at:
                    format: date-time
                    type: string
                  widget:
                    description: |
                      to the conversation endpoints, unchanged by a rename.
                    title: >
                      Widget is the widget's public key — the stable handle to
                      pass back here or
                    type: string
                  widget_id:
                    title: >
                      WidgetID is the widget's Erdo id, echoed for callers that
                      store one.
                    type: string
                type: object
          description: Success response
        default:
          $ref: '#/components/responses/APIError'
components:
  responses:
    APIError:
      content:
        application/json:
          schema:
            externalDocs:
              url: https://pkg.go.dev/encore.dev/beta/errs#Error
            properties:
              code:
                description: Error code
                example: not_found
                externalDocs:
                  url: https://pkg.go.dev/encore.dev/beta/errs#ErrCode
                type: string
              details:
                description: Error details
                type: object
              message:
                description: Error message
                type: string
            title: APIError
            type: object
      description: Error response
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

````