Skip to main content
PATCH
Update a share link

Authorizations

Authorization
string
header
required

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

Path Parameters

site
string
required

The site: its domain as registered (example.com), or its site id.

id
string
required

The share link's id, from the share links list.

Body

application/json
name
string
Required string length: 1 - 100
password
string | null

A password the viewer types before the board opens, 6 to 200 characters. Never returned.

Required string length: 6 - 200
expiresAt
string<date> | null

The last day the link opens, YYYY-MM-DD in the site's timezone.

showNotes
boolean

Whether the link shows the chart's notes.

showRevenue
boolean

Whether the link shows revenue.

hideBranding
boolean

Whether the board hides the product's branding.

Response

OK

data
object
required