Skip to content

Update the shared view of a link

POST
/v1/dashboard-links/{id}/refresh
curl --request POST \
--url https://beta-api.plune.ai/v1/dashboard-links/example/refresh \
--header 'Authorization: Bearer <token>'

Freezes the link’s widgets again as they are now (ADR 0061 §3): a renamed or changed widget shows its new recipe; an archived one, or one that can no longer be shared, drops out (409 link_empty when none is left). Owner only; audited.

id
required
string

The link

Media type application/json
object
id
required
string
label
required
string | null
widgets
required

How many widgets the link froze.

integer
periodDays
required
integer
Allowed values: 7 30 90
periodOpen
required

A visitor may pick a shorter preset; false, the period is fixed.

boolean
passwordProtected
required
boolean
expiresAt
required

null: kept until revoked.

string | null format: date-time
createdAt
required
string format: date-time
createdBy
required
string | null
sharedAt
required

When the widgets were frozen: the creation or the last update of the shared view.

string format: date-time
views
required
integer
lastViewedAt
required
string | null format: date-time
Example
{
"periodDays": 7
}

No / invalid token or session

Not the project’s owner

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No such active link in the project

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

None of the link’s widgets can be shared any more

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over