PUT
/
organisations
/
{organisationId}
/
boards
/
{boardId}
cURL
curl --request PUT \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/boards/{boardId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "hubId": "<string>",
  "status": "unknown",
  "activePublishInfo": {
    "id": "<string>",
    "taskId": "<string>",
    "lastEventId": "<string>",
    "listeners": [
      {
        "id": "<string>",
        "appNodeId": "<string>",
        "operationNodeId": "<string>",
        "url": "<string>",
        "contentType": "<string>",
        "security": {},
        "additionalHeaders": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "recentPublishHistory": [
    {
      "id": "<string>",
      "taskId": "<string>",
      "lastEventId": "<string>",
      "listeners": [
        {
          "id": "<string>",
          "appNodeId": "<string>",
          "operationNodeId": "<string>",
          "url": "<string>",
          "contentType": "<string>",
          "security": {},
          "additionalHeaders": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "tags": {},
  "thumbnailUrl": "<string>"
}'
{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "hubId": "<string>",
  "status": "unknown",
  "activePublishInfo": {
    "id": "<string>",
    "taskId": "<string>",
    "lastEventId": "<string>",
    "listeners": [
      {
        "id": "<string>",
        "appNodeId": "<string>",
        "operationNodeId": "<string>",
        "url": "<string>",
        "contentType": "<string>",
        "security": {},
        "additionalHeaders": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "deletedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "recentPublishHistory": [
    {
      "id": "<string>",
      "taskId": "<string>",
      "lastEventId": "<string>",
      "listeners": [
        {
          "id": "<string>",
          "appNodeId": "<string>",
          "operationNodeId": "<string>",
          "url": "<string>",
          "contentType": "<string>",
          "security": {},
          "additionalHeaders": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "tags": {},
  "thumbnailUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
boardId
string
required

Body

application/json

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.

​
id
string
required
​
orgId
string
required
​
name
string
required
​
status
enum<string>
required

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.

Available options:
unknown,
draft,
publishing,
published,
unpublishing
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
hubId
string
​
activePublishInfo
object

BoardPublishInfo provides information on a published board instance

​
recentPublishHistory
object[]

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.

​
deletedAt
string<date-time>
​
tags
object
​
thumbnailUrl
string<uri>

Response

A single Board result

​
id
string
required
​
orgId
string
required
​
name
string
required
​
status
enum<string>
required

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.

Available options:
unknown,
draft,
publishing,
published,
unpublishing
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
hubId
string
​
activePublishInfo
object

BoardPublishInfo provides information on a published board instance

​
recentPublishHistory
object[]

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.

​
deletedAt
string<date-time>
​
tags
object
​
thumbnailUrl
string<uri>