---
title: "Take a template on its own sample data"
method: POST
path: "/dashboards/v3/templates/{slug}/use"
tags: ["Dashboard v3"]
---

# Take a template on its own sample data

`POST /dashboards/v3/templates/{slug}/use`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/dashboards/v3/templates/{slug}/use`
- 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`

Create a new v3 dashboard from a curated template, on the template's OWN sample data. Takes no dataset: the sample is resolved from the template's primary industry and imported into this workspace if it is not already there, so the user chooses data afterwards rather than before. Returns a job_id and creates asynchronously, because it rides the ordinary apply path — a template taken on sample data has to be indistinguishable from one applied to real data. Rejects when the template has no sample for its industry, rather than landing an empty board. Auth: read on the template's source dashboard.

## Path parameters

- `slug` string, required

## Request body

- UseTemplateSpec: Take a template on its sample data
  - `params` UseTemplateParams, required
    - `project_id` integer, required
    - `request_token` string, nullable
    - `style_id` string
    - `mode` 'light' | 'dark' | 'null', nullable
    - `show_summary` boolean, nullable
    - `show_filters` boolean, nullable
    - `kpi_style` 'cards' | 'accent' | 'tinted' | 'strip' | 'null', nullable
    - `insight_style` 'list' | 'tinted' | 'cards' | 'numbered' | 'banner' | 'null', nullable
    - `header_treatment` 'photo' | 'pattern' | 'gradient' | 'plain' | 'null', nullable

## Response `201`

Document created, URL follows

- ObjectJobSchema
  - `status_code` integer, nullable
  - `job_id` integer, nullable: Created job id
  - `failure_reason` string, nullable: Failure reason if status is failure

## Other responses

- `202`: Successfully Submitted
- `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/9d8804f81a10?raw)