What it does
Create a PIN for a site. pin: 6 to 12 digits as a string, not a run like 123456 and not the same as another PIN of the site. role view (default) or edit, label (what it is for). A PIN lets people open a site by typing it on the site's PIN page, with no account or email. A site has up to 10 PINs, each 6 to 12 digits. Each PIN is a member without an email: role view sees the site, role edit also runs member actions and uploads, and rows it adds belong to that PIN. label says what it is for (Grandparents). The PIN works until it is removed. Typing it keeps that device signed in for 30 days, or until the browser closes when the visitor ticks the public computer box. The PIN is stored hashed and is never shown again after it is set. Removing a PIN ends the visits that came from it.
Plans
Works on every plan: Free, Basic, Pro and Ultra.
Parameters
| Name | Type | About |
|---|---|---|
site_idrequired | string | The id of the site. list_sites gives the ids of your sites. |
pinrequired | string | The PIN people type to open the site. |
role | one of: view, edit | view (default) sees the site; edit also runs member actions. |
label | string or null | A name to tell PINs apart, such as Kitchen tablet. |
idempotency_key | string | Any unique string (1-200 printable ASCII). A retry with the same key and arguments returns the first call's result instead of running again. Same as the Idempotency-Key header. |
Example
Call create_site_pin with these arguments:
{
"site_id": "01a1…",
"pin": "482913",
"role": "view",
"label": "Kitchen tablet"
}
Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.
Related guides
- Open a site with a PINLet family or a group in without accounts.