API Reference

Update Widget

put
https://api.vcita.biz/v3/apps/widgets/

Overview

Update an existing widget.

Authentication

Available for App Tokens only. The app must have app_type='widgets'. Apps with other types will receive 403: 'This app's type does not support widgets'.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The widget uid

Body Params
display_name
object

The widget display name in different languages

component_data
object

Component data for the widget, specifying the component name and configuration.

dimensions
object

The widget dimensions including min\max\preferred height and width.

permissions
array of strings

The permissions required for the widget to show up for a staff member

permissions
string

The module (FF) required for the widget to show up for a staff member

Responses

401

Unauthorized. The bearer token is missing or invalid.

403

Forbidden. You do not have access to this resource.

Updated 3 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago