pagehive

update_site_pin

Change a PIN's role, label (null clears it), or the PIN itself (pin).

MembersChanges dataAll plans

What it does

Change a PIN's role, label (null clears it), or the PIN itself (pin). A new PIN signs out everyone who used the old one.

Plans

Works on every plan: Free, Basic, Pro and Ultra.

Parameters

NameTypeAbout
site_idrequiredstringThe id of the site. list_sites gives the ids of your sites.
pin_idrequiredstringThe id of the PIN, from list_site_pins.
pinstringA new PIN.
roleone of: view, editThe new role: view or edit.
labelstring or nullA new label. null clears it.

Example

Call update_site_pin with these arguments:

{
  "site_id": "01a1…",
  "pin_id": "01a1…",
  "label": "Hallway tablet"
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides