Pulsoid API Documentation
DashboardRequest CredentialsDiscord
  • Intro
  • Access Token Management
    • OAuth2 Implicit Grant
    • OAuth2 Authorization Code Grant
    • OAuth2 Client Credentials Grant Type(server token)
    • Manual Token Issuing
    • OAuth2 Refreshing the token
    • Revoke authorization token
    • Validate authorization token
    • List of supported scopes
  • Read Heart Rate
    • Read Latest Heart Rate via HTTP
    • Read Heart Rate via WebSocket
    • Page
    • Read Statistics
  • Widgets Management
    • Widget Entity
    • Create Widget
    • Read Widget
    • Update Widget
  • Read Profile Information
  • Error Code Format
  • VRChat
    • VRChat World Integration
Powered by GitBook
On this page
  1. Widgets Management

Update Widget

PreviousRead WidgetNextRead Profile Information

Last updated 6 months ago

This method allows updating the information of the user's .

Request

name
value

url

https://dev.pulsoid.net/api/v1/widgets/{widget.id}

method

POST

scope

widgets:update

Body Param Accepts JSON object with the following field

name
value

configuration

Json representing new widget's configuration

Headers Parameters explained:

name
value
description

Authorization

Bearer {auth token}

Response

The response is an updated .

Curl Request Example

curl --request POST \
  --url https://pulsoid.net/api/v1/widgets/40b0131e-fe68-4020-90a0-1a5eb78fd9b4 \
  --header 'Authorization: Bearer 8c4da3ce-7ed7-4a19-a1f1-058498661e45' \
  --header 'Content-Type: application/json' \
  --data '{
  "configuration" : {
    "font": "Comics Sans"
  }
}'

Response Example

{
  "widget": {
    "id": "40b0131e-fe68-4020-90a0-1a5eb78fd9b4",
    "meta_id": "b828337f-cdb0-49d2-8e55-9b1285cd0d22",
    "configuration": {
      "font": "Comics Sans"
    },
    "name": "Widget 1"
  }
}

How to obtains access token

widget
widget
https://docs.pulsoid.net/#how-to-obtain-an-authorization-token