manage_dashboard_share
Grant or revoke an authenticated share for a saved dashboard (bt-p1opf.9: merges the former share_dashboard and revoke_dashboard_share tools; action selects the behavior). Requires at least Editor access to the model. action=‘share’: mark the dashboard as shared with the model team and return an authenticated app URL. The URL can only be opened by users who already have Bridge Town access to the model — no anonymous or public access is granted.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
model_name | Annotated[str, Field(description='Name of the Bridge Town model.')] | Yes | — | |
dashboard_name | Annotated[str, Field(description='Name of the dashboard.')] | Yes | — | |
action | Annotated[Literal['share', 'revoke'], Field(description="'share' to grant an authenticated share, or 'revoke' to end it.")] | Yes | — | |
expires_hours | `Annotated[int | None, 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’.”)]` | No | 24 |
workspace_id | `Annotated[str | None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]` | No | None |
Returns
Section titled “Returns”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.
Example
Section titled “Example”Tool Call
Section titled “Tool Call”{ "name": "manage_dashboard_share", "arguments": { "model_name": "forecasts", "dashboard_name": "ARR Bridge", "action": "share", "expires_hours": 48 }}Response
Section titled “Response”{ "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 authentication via API token or Auth0 JWT.