Sharing

Open or close

Stop the board without losing its address.

PATCH/sites/{siteId}/share/active

Open or close the board

curl --request PATCH \
  --url 'https://truestat.io/api/v1/sites/{siteId}/share/active' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": false
}'

{
  "data": {
    "url": "/share/codivupload.com",
    "slug": "codivupload.com",
    "active": false,
    "days_left": 7,
    "expires_at": null
  },
  "meta": {
    "site_id": "6fed8980-a119-4a9c-a4d4-53e448ef9f9e"
  }
}

See Shared board for the difference between closing and revoking, how the expiry clock pauses, and why revenue is off by default.

Authorizations

Authorizationstringheaderrequired

An API key from Settings → API keys. Scopes available: analytics:read, sites:read, sites:write, settings:read, settings:write, goals:read, goals:write, funnels:read, funnels:write, notes:read, notes:write, alerts:read, alerts:write, team:read, team:write, revenue:read, revenue:write.

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

siteIdstring (uuid)pathrequired

The site's id, from `GET /sites`. A site that is not yours and a site that does not exist both answer 403, so this cannot be used to discover other people's ids.

Request bodyapplication/json

activebooleanbodyrequired

True to open, false to close.

Response

application/json

The answer.

dataobject

metaobject

errorobject