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

# Update a knowledge hub

> Renames a hub, or adds websites and notes to it and reads them in the background: it answers `202` with the hub as it was, and its pages follow. A website or note the hub has is replaced by what you send; nothing is removed. A hub still being built answers `409` `knowledge_hub_not_ready`.

Free. **Scope:** campaigns, with a key that can write.



## OpenAPI

````yaml /openapi.json patch /v1/knowledge-hubs/{hubId}
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Lists
    description: >-
      Keep people or companies in lists: create and change lists, page through
      their rows, and add or remove people.
  - name: Folders
    description: Group lists of one kind into folders.
  - name: Enrichment
    description: >-
      Find people's work emails and phone numbers: one person, a batch of
      people, or a list.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged, and stopping them.
  - name: Accounts
    description: >-
      Connect the mailboxes and LinkedIn seats that campaigns and the inbox send
      from, and look after them.
  - name: Campaigns
    description: >-
      Email and LinkedIn campaigns: their steps, the people they enroll, their
      queue of messages, templates, the knowledge hubs and writing styles AI
      steps are written from, the tracking domain their links go through, and
      the lists every campaign leaves out.
  - name: Inbox
    description: >-
      Read and answer the conversations of your mailboxes and LinkedIn seats,
      and send new messages and invitations.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/knowledge-hubs/{hubId}:
    patch:
      tags:
        - Campaigns
      summary: Update a knowledge hub
      description: >-
        Renames a hub, or adds websites and notes to it and reads them in the
        background: it answers `202` with the hub as it was, and its pages
        follow. A website or note the hub has is replaced by what you send;
        nothing is removed. A hub still being built answers `409`
        `knowledge_hub_not_ready`.


        Free. **Scope:** campaigns, with a key that can write.
      operationId: patchKnowledgeHubsHubId
      parameters:
        - name: hubId
          in: path
          required: true
          description: The knowledge hub's id.
          schema:
            type: string
            minLength: 24
            maxLength: 24
            pattern: ^[0-9a-fA-F]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: A new name.
                  minLength: 1
                  maxLength: 100
                websites:
                  type: array
                  description: >-
                    1 to 20 sites to add, or to read again when the hub has
                    them. A site the hub has is replaced by what you send, so
                    `includeSubPages` and `isCompetitor` left out become false.
                    Nothing is removed.
                  minItems: 1
                  maxItems: 20
                  items:
                    type: object
                    properties:
                      url:
                        type: string
                        description: >-
                          The site to read, with or without the scheme, such as
                          `fernway.co` or `https://fernway.co/pricing`.
                        minLength: 4
                        maxLength: 2048
                      includeSubPages:
                        type: boolean
                        description: >-
                          Also read the site's pages below this address, up to
                          100. False when left out.
                      isCompetitor:
                        type: boolean
                        description: >-
                          A competitor's site: it feeds the competitor pages,
                          not your own. False when left out.
                    required:
                      - url
                notes:
                  type: array
                  description: >-
                    1 to 50 notes to add or replace, by `filename`. Nothing is
                    removed.
                  minItems: 1
                  maxItems: 50
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                        description: >-
                          What you know, in your own words, up to 60,000
                          characters.
                        minLength: 1
                        maxLength: 60000
                      filename:
                        type: string
                        description: >-
                          The note's label, and how it is matched: a note with
                          exactly this label is replaced, any other label adds a
                          note.
                        minLength: 1
                        maxLength: 255
                      isCompetitor:
                        type: boolean
                        description: >-
                          About a competitor, not your own company. False when
                          left out.
                    required:
                      - text
                      - filename
            example:
              websites:
                - url: https://fernway.co/pricing
      responses:
        '202':
          description: The knowledge hub, `processing` while its sites are read.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  companyName:
                    type: string
                  status:
                    type: string
                    description: >-
                      `processing` while it is built, then `complete`, or
                      `draft` when building failed.
                  isDefault:
                    type: boolean
                    description: The hub campaigns use when they name none.
                  createdAt:
                    type: string
                    format: date-time
                  websites:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                        includeSubPages:
                          type: boolean
                        isCompetitor:
                          type: boolean
                        parentUrl:
                          type: string
                        lastCrawledAt:
                          type: string
                          format: date-time
                          description: Absent until the site was read.
                  notes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        text:
                          type: string
                        filename:
                          type: string
                        isCompetitor:
                          type: boolean
                        hasAttachment:
                          type: boolean
                  updatedAt:
                    type: string
                    format: date-time
              example:
                id: 6a1f0c2b9d4e8a7f3c5b2e37
                name: Fernway
                companyName: Fernway
                status: processing
                isDefault: true
                websites:
                  - url: https://fernway.co
                    includeSubPages: true
                    isCompetitor: false
                notes:
                  - id: 6a1f0c2b9d4e8a7f3c5b2e39
                    text: We win on onboarding speed.
                    filename: Positioning
                    isCompetitor: false
                    hasAttachment: false
                createdAt: '2026-11-14T10:05:00.000Z'
                updatedAt: '2026-11-14T10:05:00.000Z'
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.005000'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.995000'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. When
        the limit reached does not say when it resets, such as a mail provider's
        own limit on a mailbox, Retry-After is 60. The RateLimit headers
        describe this API's own limits, so they come only with a 429 one of
        those gave. The body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://docs.outbound.dev/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.