API ReferenceBoardsTabs

Update tab

View as Markdown

Send name, position, or both. Changing position shifts the board’s other tabs to match.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
board_idstringRequiredformat: "uuid"
tab_idstringRequiredformat: "uuid"

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects an object.
namestring or nullOptional1-80 characters
New tab display name
positioninteger or nullOptional>=0

New zero-based position. Supplying it reorders the board’s other tabs to match.

Response

Successful Response
idstringformat: "uuid"
Tab identifier
namestring
Tab display name
positioninteger

Zero-based left-to-right position on the board

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error