---
title: "Share Dashboard"
method: POST
path: "/dashboards/{dashboard_id}/share"
tags: ["Dashboard"]
---

# Share Dashboard

`POST /dashboards/{dashboard_id}/share`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/{dashboard_id}/share`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Share Dashboard

## Path parameters

- `dashboard_id` integer, required

## Request body

- DashboardShareSpec: Parameters required for dashboard sharing
  - `params` DashboardShareParams, required: Encapsulated dashboard sharing parameters
    - `auth` DashboardAuth, required
      - `type_of_auth` 'mammoth' | 'public' | 'password', required: Type of authentication for sharing the dashboard.
      - `options` object, nullable: Options for sharing the dashboard, such as expiration date or access level.
      - `sequence` integer, nullable: Published presentation sequence — the draft version number the shared/published presentation was last synced to. Read from the share JSON (set by the presentation-publish path); the viewer uses it to cache-bust the published thumbnail/OG artifacts.

## Response `200`

Successfully Shared

## Other responses

- `201`: Document created, URL follows
- `400`: Bad request syntax or unsupported method
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)