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

# Update Portal Guide

> Update a portal guide.



## OpenAPI

````yaml PATCH /v1/workspaces/{workspace_id}/portal-guides/{id}
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/workspaces/{workspace_id}/portal-guides/{id}:
    patch:
      tags:
        - portals
      summary: Update Portal Guide
      description: >-
        Update a portal guide. Published guide changes reach matching customer
        portals immediately.
      operationId: patchPortalGuide
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Workspace identifier
          required: true
          description: Workspace identifier
          name: workspace_id
          in: path
        - schema:
            type: string
            minLength: 1
            description: Portal guide identifier
          required: true
          description: Portal guide identifier
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expected_updated_at:
                  type: number
                  minimum: 0
                title:
                  type: string
                  minLength: 1
                description:
                  type: string
                  nullable: true
                category:
                  type: string
                  nullable: true
                cover_image_url:
                  type: string
                  nullable: true
                cover_image_attribution:
                  type: object
                  nullable: true
                  properties:
                    source:
                      type: string
                      enum:
                        - unsplash
                    photographerName:
                      type: string
                    photographerUrl:
                      type: string
                      format: uri
                    photoUrl:
                      type: string
                      format: uri
                  required:
                    - source
                    - photographerName
                    - photographerUrl
                    - photoUrl
                blocks:
                  type: array
                  items:
                    oneOf:
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - text
                          id:
                            type: string
                          title:
                            type: string
                          body:
                            type: string
                        required:
                          - kind
                          - id
                          - body
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - place
                          id:
                            type: string
                          name:
                            type: string
                          description:
                            type: string
                          address:
                            type: string
                          mapsUrl:
                            type: string
                          imageUrl:
                            type: string
                          imageAttribution:
                            type: object
                            properties:
                              source:
                                type: string
                                enum:
                                  - unsplash
                              photographerName:
                                type: string
                              photographerUrl:
                                type: string
                                format: uri
                              photoUrl:
                                type: string
                                format: uri
                            required:
                              - source
                              - photographerName
                              - photographerUrl
                              - photoUrl
                          hostTip:
                            type: string
                          placeType:
                            type: string
                            enum:
                              - restaurant
                              - cafe
                              - bar
                              - bakery
                              - grocery
                              - shopping
                              - beach
                              - park
                              - trail
                              - viewpoint
                              - museum
                              - landmark
                              - activity
                              - tour
                              - gym
                              - spa
                              - pharmacy
                              - medical
                              - transit
                              - parking
                              - other
                          distanceFromProperty:
                            type: string
                          tags:
                            type: array
                            items:
                              type: string
                          bookingUrl:
                            type: string
                          phone:
                            type: string
                          website:
                            type: string
                          priceBand:
                            type: string
                            enum:
                              - $
                              - $$
                              - $$$
                              - $$$$
                          hours:
                            type: string
                        required:
                          - kind
                          - id
                          - name
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - tip
                          id:
                            type: string
                          body:
                            type: string
                          tone:
                            type: string
                            enum:
                              - info
                              - tip
                              - warning
                              - danger
                        required:
                          - kind
                          - id
                          - body
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - list
                          id:
                            type: string
                          title:
                            type: string
                          variant:
                            type: string
                            enum:
                              - bulleted
                              - ordered
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                text:
                                  type: string
                              required:
                                - id
                                - text
                        required:
                          - kind
                          - id
                          - variant
                          - items
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - facts
                          id:
                            type: string
                          title:
                            type: string
                          variant:
                            type: string
                            enum:
                              - pairs
                              - schedule
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                label:
                                  type: string
                                value:
                                  type: string
                              required:
                                - id
                                - label
                                - value
                        required:
                          - kind
                          - id
                          - variant
                          - rows
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - media
                          id:
                            type: string
                          title:
                            type: string
                          layout:
                            type: string
                            enum:
                              - single
                              - gallery
                              - steps
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                imageUrl:
                                  type: string
                                imageAttribution:
                                  type: object
                                  properties:
                                    source:
                                      type: string
                                      enum:
                                        - unsplash
                                    photographerName:
                                      type: string
                                    photographerUrl:
                                      type: string
                                      format: uri
                                    photoUrl:
                                      type: string
                                      format: uri
                                  required:
                                    - source
                                    - photographerName
                                    - photographerUrl
                                    - photoUrl
                                caption:
                                  type: string
                                hotspots:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      x:
                                        type: number
                                      'y':
                                        type: number
                                      label:
                                        type: string
                                    required:
                                      - id
                                      - x
                                      - 'y'
                                      - label
                              required:
                                - id
                        required:
                          - kind
                          - id
                          - layout
                          - items
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - embed
                          id:
                            type: string
                          variant:
                            type: string
                            enum:
                              - video
                              - pdf
                              - tour
                          url:
                            type: string
                            format: uri
                          title:
                            type: string
                        required:
                          - kind
                          - id
                          - variant
                          - url
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - action
                          id:
                            type: string
                          label:
                            type: string
                          url:
                            type: string
                            format: uri
                          description:
                            type: string
                          price:
                            type: string
                        required:
                          - kind
                          - id
                          - label
                          - url
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - contact
                          id:
                            type: string
                          title:
                            type: string
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                role:
                                  type: string
                                phone:
                                  type: string
                                sms:
                                  type: boolean
                                whatsapp:
                                  type: boolean
                                note:
                                  type: string
                              required:
                                - id
                                - name
                        required:
                          - kind
                          - id
                          - rows
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - checklist
                          id:
                            type: string
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                label:
                                  type: string
                              required:
                                - id
                                - label
                        required:
                          - kind
                          - id
                          - items
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - schedule
                          id:
                            type: string
                          rows:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                label:
                                  type: string
                                value:
                                  type: string
                              required:
                                - id
                                - label
                                - value
                        required:
                          - kind
                          - id
                          - rows
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - photoSteps
                          id:
                            type: string
                          steps:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                imageUrl:
                                  type: string
                                imageAttribution:
                                  type: object
                                  properties:
                                    source:
                                      type: string
                                      enum:
                                        - unsplash
                                    photographerName:
                                      type: string
                                    photographerUrl:
                                      type: string
                                      format: uri
                                    photoUrl:
                                      type: string
                                      format: uri
                                  required:
                                    - source
                                    - photographerName
                                    - photographerUrl
                                    - photoUrl
                                caption:
                                  type: string
                              required:
                                - id
                                - caption
                        required:
                          - kind
                          - id
                          - steps
                      - type: object
                        properties:
                          kind:
                            type: string
                            enum:
                              - video
                          id:
                            type: string
                          url:
                            type: string
                          title:
                            type: string
                        required:
                          - kind
                          - id
                          - url
                status:
                  type: string
                  enum:
                    - draft
                    - published
                targeting:
                  type: object
                  nullable: true
                  properties:
                    listingIds:
                      type: array
                      items:
                        type: string
                    listingGroupIds:
                      type: array
                      items:
                        type: string
                        minLength: 1
                show_after_check_in_only:
                  type: boolean
              required:
                - expected_updated_at
      responses:
        '200':
          description: Update Portal Guide
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      workspace_id:
                        type: string
                      title:
                        type: string
                      description:
                        type: string
                      category:
                        type: string
                      cover_image_url:
                        type: string
                      cover_image_attribution:
                        type: object
                        properties:
                          source:
                            type: string
                            enum:
                              - unsplash
                          photographerName:
                            type: string
                          photographerUrl:
                            type: string
                            format: uri
                          photoUrl:
                            type: string
                            format: uri
                        required:
                          - source
                          - photographerName
                          - photographerUrl
                          - photoUrl
                      blocks:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - text
                                id:
                                  type: string
                                title:
                                  type: string
                                body:
                                  type: string
                              required:
                                - kind
                                - id
                                - body
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - place
                                id:
                                  type: string
                                name:
                                  type: string
                                description:
                                  type: string
                                address:
                                  type: string
                                mapsUrl:
                                  type: string
                                imageUrl:
                                  type: string
                                imageAttribution:
                                  type: object
                                  properties:
                                    source:
                                      type: string
                                      enum:
                                        - unsplash
                                    photographerName:
                                      type: string
                                    photographerUrl:
                                      type: string
                                      format: uri
                                    photoUrl:
                                      type: string
                                      format: uri
                                  required:
                                    - source
                                    - photographerName
                                    - photographerUrl
                                    - photoUrl
                                hostTip:
                                  type: string
                                placeType:
                                  type: string
                                  enum:
                                    - restaurant
                                    - cafe
                                    - bar
                                    - bakery
                                    - grocery
                                    - shopping
                                    - beach
                                    - park
                                    - trail
                                    - viewpoint
                                    - museum
                                    - landmark
                                    - activity
                                    - tour
                                    - gym
                                    - spa
                                    - pharmacy
                                    - medical
                                    - transit
                                    - parking
                                    - other
                                distanceFromProperty:
                                  type: string
                                tags:
                                  type: array
                                  items:
                                    type: string
                                bookingUrl:
                                  type: string
                                phone:
                                  type: string
                                website:
                                  type: string
                                priceBand:
                                  type: string
                                  enum:
                                    - $
                                    - $$
                                    - $$$
                                    - $$$$
                                hours:
                                  type: string
                              required:
                                - kind
                                - id
                                - name
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - tip
                                id:
                                  type: string
                                body:
                                  type: string
                                tone:
                                  type: string
                                  enum:
                                    - info
                                    - tip
                                    - warning
                                    - danger
                              required:
                                - kind
                                - id
                                - body
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - list
                                id:
                                  type: string
                                title:
                                  type: string
                                variant:
                                  type: string
                                  enum:
                                    - bulleted
                                    - ordered
                                items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      text:
                                        type: string
                                    required:
                                      - id
                                      - text
                              required:
                                - kind
                                - id
                                - variant
                                - items
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - facts
                                id:
                                  type: string
                                title:
                                  type: string
                                variant:
                                  type: string
                                  enum:
                                    - pairs
                                    - schedule
                                rows:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      label:
                                        type: string
                                      value:
                                        type: string
                                    required:
                                      - id
                                      - label
                                      - value
                              required:
                                - kind
                                - id
                                - variant
                                - rows
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - media
                                id:
                                  type: string
                                title:
                                  type: string
                                layout:
                                  type: string
                                  enum:
                                    - single
                                    - gallery
                                    - steps
                                items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      imageUrl:
                                        type: string
                                      imageAttribution:
                                        type: object
                                        properties:
                                          source:
                                            type: string
                                            enum:
                                              - unsplash
                                          photographerName:
                                            type: string
                                          photographerUrl:
                                            type: string
                                            format: uri
                                          photoUrl:
                                            type: string
                                            format: uri
                                        required:
                                          - source
                                          - photographerName
                                          - photographerUrl
                                          - photoUrl
                                      caption:
                                        type: string
                                      hotspots:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                            x:
                                              type: number
                                            'y':
                                              type: number
                                            label:
                                              type: string
                                          required:
                                            - id
                                            - x
                                            - 'y'
                                            - label
                                    required:
                                      - id
                              required:
                                - kind
                                - id
                                - layout
                                - items
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - embed
                                id:
                                  type: string
                                variant:
                                  type: string
                                  enum:
                                    - video
                                    - pdf
                                    - tour
                                url:
                                  type: string
                                  format: uri
                                title:
                                  type: string
                              required:
                                - kind
                                - id
                                - variant
                                - url
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - action
                                id:
                                  type: string
                                label:
                                  type: string
                                url:
                                  type: string
                                  format: uri
                                description:
                                  type: string
                                price:
                                  type: string
                              required:
                                - kind
                                - id
                                - label
                                - url
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - contact
                                id:
                                  type: string
                                title:
                                  type: string
                                rows:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      name:
                                        type: string
                                      role:
                                        type: string
                                      phone:
                                        type: string
                                      sms:
                                        type: boolean
                                      whatsapp:
                                        type: boolean
                                      note:
                                        type: string
                                    required:
                                      - id
                                      - name
                              required:
                                - kind
                                - id
                                - rows
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - checklist
                                id:
                                  type: string
                                items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      label:
                                        type: string
                                    required:
                                      - id
                                      - label
                              required:
                                - kind
                                - id
                                - items
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - schedule
                                id:
                                  type: string
                                rows:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      label:
                                        type: string
                                      value:
                                        type: string
                                    required:
                                      - id
                                      - label
                                      - value
                              required:
                                - kind
                                - id
                                - rows
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - photoSteps
                                id:
                                  type: string
                                steps:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      imageUrl:
                                        type: string
                                      imageAttribution:
                                        type: object
                                        properties:
                                          source:
                                            type: string
                                            enum:
                                              - unsplash
                                          photographerName:
                                            type: string
                                          photographerUrl:
                                            type: string
                                            format: uri
                                          photoUrl:
                                            type: string
                                            format: uri
                                        required:
                                          - source
                                          - photographerName
                                          - photographerUrl
                                          - photoUrl
                                      caption:
                                        type: string
                                    required:
                                      - id
                                      - caption
                              required:
                                - kind
                                - id
                                - steps
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - video
                                id:
                                  type: string
                                url:
                                  type: string
                                title:
                                  type: string
                              required:
                                - kind
                                - id
                                - url
                      status:
                        type: string
                        enum:
                          - draft
                          - published
                          - archived
                      targeting:
                        type: object
                        properties:
                          listingIds:
                            type: array
                            items:
                              type: string
                          listingGroupIds:
                            type: array
                            items:
                              type: string
                              minLength: 1
                      show_after_check_in_only:
                        type: boolean
                      order:
                        type: number
                      created_at:
                        type: number
                      updated_at:
                        type: number
                    required:
                      - id
                      - workspace_id
                      - title
                      - blocks
                      - status
                      - created_at
                      - updated_at
                required:
                  - data
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````