Skip to content

manage_dashboard_share

For action=‘delete’, preview dashboard_id and retention, then confirm with the returned token and workspace_id. Use action=‘share’ or ‘revoke’ only for explicit team access changes.

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes—
dashboard_nameAnnotated[str, Field(description='Name of the dashboard.')]Yes—
actionAnnotated[Literal['share', 'revoke', 'delete'], Field(description="'share' to grant an authenticated share, 'revoke' to end it, or 'delete' to preview/confirm removal of the saved dashboard identified by dashboard_id.")]Yes—
expires_hours`Annotated[intNone, Field(description=f”Sharing policy duration in hours (1–{_MAX_EXPIRES_HOURS}, default: 24). Pass null explicitly for an indefinite authenticated share that never expires until revoked. Finite values outside the allowed range raise a validation error. Only applies to action=‘share’; ignored for action=‘revoke’.”)]`No24
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone
dashboard_id`Annotated[uuid.UUIDNone, Field(description=“Exact dashboard UUID from list_dashboards. Required only for action=‘delete’; the confirmation token is bound to this ID, model, dashboard name, and workspace.”)]`NoNone
dry_runAnnotated[bool, Field(description="For action='delete', defaults true and previews without mutation. Pass false with the returned confirmation_token to delete. Ignored for share/revoke.")]NoTrue
confirmation_token`Annotated[strNone, Field(description=“Token returned by the action=‘delete’ preview; required to delete.”)]`NoNone

Returns a structured object. Top-level fields:

  • dashboard_id (string)
  • dashboard_name (string)
  • model (string)
  • action (string)
  • dashboard_url (string)
  • access_note (string)
  • expires_hours (integer)
  • share_expires_at (string)

See the response example below for the full payload shape.

{
"name": "manage_dashboard_share",
"arguments": {
"model_name": "forecasts",
"dashboard_name": "ARR Bridge",
"action": "share",
"expires_hours": 48
}
}
{
"dashboard_id": "77777777-7777-7777-7777-777777777777",
"dashboard_name": "ARR Bridge",
"model": "forecasts",
"action": "share",
"dashboard_url": "https://app.bridgetown.builders/dashboards/77777777-7777-7777-7777-777777777777",
"access_note": "This URL requires the recipient to be a collaborator on 'forecasts' with a Bridge Town account. No anonymous access is granted.",
"expires_hours": 48,
"share_expires_at": "2026-03-31T10:00:00+00:00"
}
  • Module: Dashboards
  • Requires an authenticated Bridge Town session (OAuth) or an API token.