Update a Staff Widgets Board

put

https://api.vcita.biz/v3/apps/staff_widgets_boards/{uid}

Overview

Update a staff widget board.

Available for Staff Tokens

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid

string

required

The staff widgets board UID. Must be a valid UID from an existing Staff Widgets Board. Use GET /v3/apps/staff_widgets_boards to find valid UIDs. Invalid UIDs will return 404 with message 'StaffWidgetsBoard Not Exist'.

Body Params

board_layout_code_name

string

enum

required

A string representing the board layout. Must be unique per staff member when combined with type.

Allowed:

type

string

enum

required

The grid frame of the layout, determines the layout frame containing the board. Must be unique per staff member when combined with board_layout_code_name.

Allowed:

sections

array of objects

required

An array of sections for the widgets board

sections*

Responses

401

Unauthorized. The bearer token is missing or invalid.

403

Forbidden. You do not have access to this resource.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201