> ## Documentation Index > Fetch the complete documentation index at: https://docs.lobbystack.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a widget key > Changes the fields sent. Values the key already has change nothing. ## OpenAPI ````yaml /api-reference/openapi.json patch /widget-keys/{widget_key_id} openapi: 3.1.0 info: title: LobbyStack API version: v1 description: >- Read calls, contacts, appointments and messages, book appointments, and subscribe to webhooks. Authenticate with an API key in the Authorization header. A platform key also names the business it acts on in the LobbyStack-Business header. Each key allows 120 requests per minute by default. servers: - url: https://app.lobbystack.com/api/v1 security: - bearerAuth: [] tags: - name: Business - name: Receptionist - name: Billing - name: Phone numbers - name: Onboarding - name: Team - name: Website chat - name: Calendars - name: Notifications - name: Calls - name: Contacts - name: Appointments - name: Messages - name: Knowledge - name: Webhooks - name: Platform paths: /widget-keys/{widget_key_id}: patch: tags: - Website chat summary: Update a widget key description: Changes the fields sent. Values the key already has change nothing. operationId: updateWidgetKey parameters: - name: widget_key_id in: path required: true description: The widget key id. schema: type: string format: uuid - name: LobbyStack-Business in: header description: >- The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business. schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WidgetKeyUpdate' responses: '200': description: OK content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/WidgetKey' '400': description: >- The request is invalid (invalid_request), or a platform key sent no LobbyStack-Business header (business_required). content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key is missing, invalid, or revoked (unauthorized). content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Refused. insufficient_scope: the key lacks the business:write scope. forbidden: a per-business key named another business in LobbyStack-Business. key_owner_inactive: the person the key acts for can't any more: a per-business key's creator is no longer an owner or admin, or a platform key's owner_email has no verified LobbyStack account. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- Not found (not_found), including a business a platform key cannot act on. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The request conflicts with the current state. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Too many requests (rate_limited). Wait for the Retry-After header's number of seconds. content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: integer description: Seconds to wait. security: - bearerAuth: [] components: schemas: WidgetKeyUpdate: type: object properties: label: description: null removes the label. anyOf: - type: string minLength: 1 maxLength: 120 - type: 'null' allowed_origins: description: Replaces the list. maxItems: 50 type: array items: type: string maxLength: 2000 format: uri config: description: Replaces the whole configuration. type: object properties: color: type: string pattern: ^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ position: type: string enum: - bottom-right - bottom-left title: type: string maxLength: 160 subtitle: type: string maxLength: 320 greeting: type: string maxLength: 400 locale: description: >- The widget's language: en, fr, es or sr. Left out, it follows the visitor's browser. type: string enum: - en - fr - es - sr lead_form: description: Asks visitors for their contact details. type: object properties: enabled: type: boolean require_phone: type: boolean require_email: type: boolean show_before_chat: type: boolean required: - enabled additionalProperties: false additionalProperties: false status: description: A revoked key can't be turned back on. type: string enum: - active - disabled - revoked additionalProperties: false WidgetKey: type: object properties: id: type: string format: uuid description: Stable identifier (UUID). label: type: - string - 'null' status: type: string enum: - active - disabled - revoked description: >- active: the widget works. disabled: it stops until it's turned back on. revoked: it stops for good. allowed_origins: type: array items: type: string description: The websites the widget runs on, such as https://example.com. config: type: object properties: color: type: string pattern: ^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ position: type: string enum: - bottom-right - bottom-left title: type: string maxLength: 160 subtitle: type: string maxLength: 320 greeting: type: string maxLength: 400 locale: description: >- The widget's language: en, fr, es or sr. Left out, it follows the visitor's browser. type: string enum: - en - fr - es - sr lead_form: description: Asks visitors for their contact details. type: object properties: enabled: type: boolean require_phone: type: boolean require_email: type: boolean show_before_chat: type: boolean required: - enabled additionalProperties: false additionalProperties: false description: How the widget looks and behaves. last_used_at: anyOf: - type: string format: date-time description: ISO 8601 timestamp in UTC. - type: 'null' created_at: type: string format: date-time description: ISO 8601 timestamp in UTC. required: - id - label - status - allowed_origins - config - last_used_at - created_at additionalProperties: false description: A key that puts the chat widget on the business's websites. Error: type: object properties: error: type: object properties: code: type: string enum: - invalid_request - unauthorized - forbidden - insufficient_scope - not_found - conflict - idempotency_key_reused - idempotency_request_in_progress - booking_disabled - booking_requires_confirmation - slot_unavailable - rate_limited - rate_limit_unavailable - method_not_allowed - internal_error - business_required - key_owner_inactive - plan_limit_reached message: type: string details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.