Shared Dashboards

Archive a shared dashboard link

Archive one share link. The uuid stops resolving immediately, so anyone holding the URL loses access — this is the revoke button.

Archiving frees the shop to create a new link, which gets a fresh uuid and a fresh password rather than reviving the archived one's settings. Use PATCH ... {status: inactive} instead if you only want to pause a link you intend to bring back.

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

delete/shared-dashboards/{share_uuid}

Path parameters

share_uuidstring required

Share link UUID.

Share link UUID.

Headers

Idempotency-Keystring nullable

Response

Successful Response

successboolean required
uuidstring required
messagestring required

Changes

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