Sign in
Shared Dashboards

Update a shared dashboard link

Reconfigure one share link in place — the uuid and share_url stay valid, so anyone already holding the link keeps working.

Rotate the viewer password with password, take the link offline without archiving it with status: inactive, move or clear the locked reporting window, and change which cards the viewer sees with report_config. Omitted fields are left alone, so a password rotation never wipes the metric selection. Clearing the locked window needs clear_lock: true — omitted dates mean 'unchanged', not 'unlock'.

Returns 404 if the link does not exist or belongs to a shop this key does not cover. Requires read_write scope.

patch/shared-dashboards/{share_uuid}

Path parameters

share_uuidstring required

Share link UUID.

Share link UUID.

Headers

Idempotency-Keystring nullable

Request body

passwordstring nullable

Rotate the viewer password.

statusstring nullable

active or inactive. Use DELETE to archive.

locked_start_datestring date nullable
locked_end_datestring date nullable
clear_lockboolean

Remove the locked window entirely. Cannot be combined with a locked date range — omitted dates mean 'leave it alone', so this flag is how you say 'unlock'.

Response

Successful Response

successboolean required
messagestring required
uuidstring required
statusstring required
share_urlstring
created_atstring
locked_start_datestring date nullable
locked_end_datestring date nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.