---
title: "Create a signage template"
method: POST
path: "/v1/signage-templates"
tags: ["signage-templates"]
---

# Create a signage template

`POST /v1/signage-templates`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/signage-templates`
- Auth: HTTP bearer

Create a signage template instance from a configuration object containing archetype, style, palette, orientation, and content.

**Notes.**
- The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example `lastSnapshotAt`) are absent rather than null. `GET` returns every column.

## Request body

- object
  - `name` string, required
  - `config` union: A configuration object, or the same as a JSON string. Default `{}`.
    - object: The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
    - string
  - `nodeId` string, nullable: Home location. Default: the caller's own location.
  - `masterId` string, nullable: An id from `GET /v1/signage-master-templates`.

## Response `201`

Success.

- object
  - `data` object, required
    - `id` string, required: Signage template id.
    - `spaceId` string, required
    - `name` string, required
    - `config` object, required: The template configuration: `archetype`, `style`, `palette`, `orientation`, `content`, and the `schemaVersion` the API stamps on every write.
    - `nodeId` string, nullable
    - `masterId` string, nullable
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `422`: Missing name, invalid JSON, or a location outside this workspace.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)