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

# Put organisations boards

> Update an existing board, by ID for the given organisation.




## OpenAPI

````yaml put /organisations/{organisationId}/boards/{boardId}
openapi: 3.0.3
info:
  title: Switchboard API
  description: >-
    The Switchboard API provides users the ability to manage their Apps,
    Integrations and Workflows
  version: 0.0.1-alpha.0
servers:
  - url: https://platform.versori.com/api/switchboard/v1alpha1/
    description: Production server
  - url: http://localhost:8080/v1alpha1/
    description: Localhost
security:
  - apiKey: []
paths:
  /organisations/{organisationId}/boards/{boardId}:
    put:
      tags:
        - boards
      description: |
        Update an existing board, by ID for the given organisation.
      operationId: UpdateBoard
      parameters:
        - name: organisationId
          in: path
          required: true
          schema:
            type: string
          example: '101'
        - name: boardId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        $ref: '#/components/requestBodies/UpdateBoardRequest'
      responses:
        '200':
          $ref: '#/components/responses/GetBoardResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  requestBodies:
    UpdateBoardRequest:
      description: >
        Payload to update an existing Board.


        The `id` and `orgId` fields are immutable and must match the fields from
        the URL. This is a full replace/update,

        any unset fields will be unset in the database.
      content:
        application/json:
          schema:
            type: object
            allOf:
              - $ref: '#/components/schemas/Board'
  responses:
    GetBoardResponse:
      description: A single Board result
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Board'
    ErrorResponse:
      description: The default error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Board:
      type: object
      properties:
        id:
          type: string
        orgId:
          type: string
        name:
          type: string
        hubId:
          type: string
        status:
          $ref: '#/components/schemas/BoardStatus'
        activePublishInfo:
          $ref: '#/components/schemas/BoardPublishInfo'
        recentPublishHistory:
          description: >
            RecentPublishHistory is an array of BoardPublishInfo containing up
            to the last 5 publishes for a board. If

            full history is required, users should use the ListPublishHistory
            operation for a paginated view.
          type: array
          items:
            $ref: '#/components/schemas/BoardPublishInfo'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
        tags:
          $ref: '#/components/schemas/BoardTagsBody'
        thumbnailUrl:
          type: string
          format: uri
      required:
        - id
        - orgId
        - name
        - status
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        extensions:
          type: object
      required:
        - code
        - message
    BoardStatus:
      description: >
        BoardStatus is used to indicate the status of a board. The "unknown"
        status is used in case of inconsistencies

        in the database with the Board scheduler and the API cannot deduce the
        correct status without administrator

        intervention.


        If the status is "unknown", then clients should assume it's in a
        draft/published state based on

        whether the board has an "activePublishInfo" field. If a board cannot be
        published due to it already

        being published and the "activePublishInfo" field is null, users should
        contact support.
      type: string
      enum:
        - unknown
        - draft
        - publishing
        - published
        - unpublishing
    BoardPublishInfo:
      type: object
      description: BoardPublishInfo provides information on a published board instance
      properties:
        id:
          type: string
        taskId:
          description: >
            TaskID is a unique identifier for the execution of a board. Each
            time a board is (re)published a new task ID

            will be generated.
          type: string
        lastEventId:
          description: >
            LastEventID is the last observed event before this board was
            published. This may not be the last event on

            the stream for this board, since the observer may not have replayed
            all events at the time of publish. As

            such, the version of the board which will be executed is defined by
            this field, and not necessarily the

            latest event on the stream.
          type: string
        listeners:
          type: array
          items:
            $ref: '#/components/schemas/BoardListener'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
        - id
        - taskId
        - lastEventId
        - listeners
        - createdAt
        - updatedAt
    BoardTagsBody:
      type: object
      x-go-type: map[string][]string
    BoardListener:
      description: >
        BoardListener provides information on where a board is listening for
        external events.
      type: object
      properties:
        id:
          type: string
        appNodeId:
          description: >
            AppNodeID is the identifier of the App Node to which this listener's
            operation belongs to.
          type: string
        operationNodeId:
          description: >
            OperationNodeID is the identifier of the Operation within the App
            Node, which is listening for data from an

            external source.
          type: string
        url:
          description: >
            URL is the address for where the Node specified by NodeID is
            listening. Downstream services (such as

            webhooks) should be configured with this URL.
          type: string
        contentType:
          description: >
            ContentType is the "content-type" header for which data should be
            sent with. Initially only

            "application/json" is supported but other content types may be added
            in the future.
          type: string
        security:
          description: >
            Security defines any parameters which external services must supply
            in order for Switchboard to acknowledge

            an incoming event. If this is defined but an external service does
            not supply matching information, the

            event will be ignored.
          type: object
        additionalHeaders:
          description: >
            AdditionalHeaders describes any other headers which the downstream
            service must supply with the request.
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
        - id
        - appNodeId
        - operationNodeId
        - url
        - contentType
        - createdAt
        - updatedAt
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization

````