---
title: "Update a signage template"
method: PATCH
path: "/v1/signage-templates/{id}"
tags: ["signage-templates"]
---

# Update a signage template

`PATCH /v1/signage-templates/{id}`

## Request

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

Edit a signage template instance's configuration or name. Screens currently playing it receive an updated manifest reflecting the change.

**Notes.**
- When the PATCH does not send `config`, the response carries the stored config as it is: an old row is not brought to the current `schemaVersion` here (GET does that).

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string
  - `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`.
  - `baseUpdatedAt` string: Optimistic concurrency: the `updatedAt` you read. A stale value is refused with 409 `conflict` and the `current` row.

## Response `200`

Success.

- object
  - `data` SignageTemplate, required: A signage template instance in this workspace.
    - `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, required
    - `masterId` string, nullable, required: The master template it was copied from, if any.
    - `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`: Moving it to a location where you lack creative.edit.
- `404`: No such signage template in this workspace.
- `409`: `conflict`: the row changed since `baseUpdatedAt`; the body carries `current`.
- `422`: Invalid JSON.
- `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)