Skip to main content
PUT
/
api
/
board
/
{boardId}
Updates an existing board.
curl --request PUT \
  --url https://{tenant}.ekso.app/api/board/{boardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "container": [
    "<string>"
  ],
  "resource": [
    "<string>"
  ],
  "budgetHours": 123,
  "budgetChange": [
    {
      "id": "<string>",
      "reasonId": "<string>",
      "userId": "<string>",
      "initials": "<string>",
      "dated": "2023-11-07T05:31:56Z",
      "changeDelta": 123
    }
  ],
  "locked": true,
  "archived": true,
  "role": [
    {
      "role": 123,
      "userGroup": [
        "<string>"
      ]
    }
  ],
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Path Parameters

boardId
string
required

The board ID from the route.

Body

The updated board data.

entity
null | string
name
string
description
string
container
string[]
resource
string[]
budgetHours
budgetChange
object[]
locked
boolean
archived
boolean
role
object[]
tenantId
string
id
string
created
string<date-time>
createdBy
string
updated
string<date-time>
updatedBy
string
deleted
boolean

Response

Board updated successfully.