Header Buttons

By default, there are 2 system buttons in the header: Timeline and Device Info. They can't be removed or hidden.

You can add up to 2 custom buttons which will open a Standalone Page to each of them.

Tap the “plus” icon at the top of the header, and choose the page that should be opened.

Header button settings

Datastream (optional) - choose Datastream if you plan to change layout with firmware API or HTTP API setProperty command.

Page - Select a page to open. Only Standalone Pages are supported.

Icon - Define how this button will appear to the user.

Appearance Animation - The page can slide in from the bottom or from the right.

Change Header Button Properties

You can change certain properties of the button from your hardware. For that, use this command:

Blynk.setProperty(vPin, "widgetProperty", "propertyValue"); 

Where:

• vPin is: virtual pin number the widget is assigned to

• widgetProperty: property you want to change

• propertyValue: value of the property you want to change

Don't put Blynk.setProperty() into the void loop() as it can cause a flood of messages and your hardware will be disconnected. Send such updates only when necessary, or use timers.

Properties you can change

You can change the properties isHidden, and page of the button from your hardware. The URL must be encoded, so spaces in labels must be replaced with %20, and color hexadecimal values in the HTTP API URL must include the hash # character urlencoded as %23.

Change Header Button Properties

Show/Hide

You can hide the button by changing isHidden property from device:

Blynk.setProperty(V1, "isHidden", "propertyValue");

Change Page Target

This command will set which page should open when the button is pressed. PageId can be found in the mobile app in developer mode: Toolbox -> Pages

Blynk.setProperty(V1, “page”, “pageId”);

Change button properties via HTTPs API

Updates the Datastream Property and all assigned Widgets

GET https://{server_address}/external/api/update/property?token={your 32 char token}&pin={your vPin}&{property}={value}

The endpoint allows you to update the Datastream Property value via GET request. All widgets (both web and mobile) that are assigned to this datastream will inherit this property. The Datastream Property is persistent and will be stored forever until you change it with another value. In order to clear the property you need to clear the device data in device actions menu.

Example: https://blynk.cloud/external/api/update/property?token=GVki9IC70vb3IqvsV0YD3el4y0OpneL1&pin=V1&isHidden=true

Path Parameters

Name	Type	Description
{server address}*	string	Get from the bottom right of your Blynk console. More information.

Query Parameters

Name	Type	Description
token*	string	Device auth token from Device info
pin*	string	The datastream virtual pin (should start with "v")
{property}	string	The property of the widget you want to update: isHidden
isHidden	string	true or false
page	string	pageID

200 Success

400 Could not find a device token

{"error":{"message":"Invalid token."}}