DigSign

DigSign API for developers

Do from your own systems what you do in the panel: change a playlist from your point of sale, send a message to the screens from a script, or check which screens are online.

Getting started

Create a key in the panel, in Settings → API (only a company admin can), and send it in every request:

curl https://digsign.app/api/v1/branches \
  -H "Authorization: Bearer YOUR_API_KEY"

Send the fields as JSON:

curl -X POST https://digsign.app/api/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body": "We close at 6 pm today", "duration_seconds": 60}'
{
  "screens_reached": 3,
  "screens_not_reached": 0,
  "seconds": 60,
  "url": "/screen-messages"
}

How it works

Errors

401The key is missing, wrong or was revoked.
403The role of the key's user doesn't allow that change.
404There is nothing with that id in your company, or the endpoint doesn't exist.
422A field is wrong or the change can't be made. The answer says why: {"message": "…", "errors": ["…"]}.
429Too many requests: wait a minute.

Use DigSign from Claude, ChatGPT and other AI apps (MCP)

DigSign is also an MCP server: add it to your AI app and ask in your own words, for example "show the lunch menu at the Centro branch from 11 to 3" or "which screens are offline?". The AI app uses the same actions as this API.

https://digsign.app/mcp

The app acts as the person who connected it, with their role, and asks you before making a change. It doesn't reach users, billing or support requests, and files are uploaded in the panel. Disconnect it from the AI app, or a company admin can do it in Settings → API.

Endpoints

Fields marked with * are required.

Account

GET /account
The company: plan, screens in use and online, branches, offline alerts.
PUT /account/offline-alerts
Emails when a screen stops connecting.
enabled (boolean), minutes (15, 30, 60, 120 or 240), extra_emails (list; the whole list)

Branches and screens

GET /branches
Every branch with its screens.
GET /branches/{branch_id}
One branch: screens (id, online, last seen), layout, zones, rest hours, text band, widgets, playlists, dayparts and schedules.
POST /branches
Creates a branch.
name*, description, active (boolean)
PATCH /branches/{branch_id}
Renames a branch or turns it on or off.
name, description, active (boolean)
DELETE /branches/{branch_id}
Deletes a branch. Its screens stop showing content.
PUT /branches/{branch_id}/layout
Screen layout, split screen and rest hours.
layout (fullscreen, strip_left, strip_right, strip_top, strip_bottom, zones_2, zones_3), zone2_playlist_id, zone3_playlist_id, city, rest_from (HH:MM), rest_to (HH:MM), rest (false to remove the rest hours)
PUT /branches/{branch_id}/ticker
The scrolling text band at the bottom.
mode* (text, rss, none), text (max 500), rss_url, color (dark, purple, red, blue, green, amber or #RRGGBB), speed (slow, normal, fast)
POST /branches/{branch_id}/widgets
Adds a widget to the strip.
type* (clock, weather, manual_text, static_media, countdown), label, value, target (countdown: YYYY-MM-DDTHH:MM), media_id (static_media)
PATCH /branches/{branch_id}/widgets/{widget_id}
Changes a widget, e.g. the number of a "now serving" text.
label, value, target, media_id, active (boolean), position (0 = first)
DELETE /widgets/{widget_id}
Removes a widget.
POST /branches/{branch_id}/refresh
Tells the screens of a branch to download their content now.
POST /screens
Pairs a screen with the code it shows.
code*, branch_id*
POST /screens/{screen_id}/restart
Restarts the app on a screen (Android TV app only).
DELETE /screens/{screen_id}
Unpairs a screen.

Media

GET /media
The media library (newest first, at most 100).
search (query string)
POST /media
Uploads an image or video (multipart/form-data with "file"), or adds a web page or YouTube video (JSON with "url").
file (jpg, png, mp4, mov, avi, webm; max 100 MB) or url; title (required with url), description, type (web, youtube), duration_seconds
PATCH /media/{media_id}
Title or description; for a web page or YouTube video also its link and seconds.
title, description, url, duration_seconds
DELETE /media/{media_id}
Deletes a file from the library and from its playlists.

Playlists

GET /playlists
Every playlist with its branches.
include_items (query string, true to list the files of each one)
POST /playlists
Creates a playlist.
name*, description, seconds_per_item (default 10), media_ids (list, in order)
PATCH /playlists/{playlist_id}
Name, seconds per item, on or off, or until when it is valid.
name, description, seconds_per_item, active (boolean), valid_until (YYYY-MM-DD, empty to clear)
DELETE /playlists/{playlist_id}
Deletes a playlist.
PUT /playlists/{playlist_id}/media
Replaces the files of a playlist, in the order given. Its screens update on their own.
media_ids* (list)
PUT /playlists/{playlist_id}/branches
Puts a playlist on branches or takes it off.
branch_ids* (list), action* (assign, unassign)

Time slots and special dates

POST /dayparts
A playlist for some hours of some weekdays (e.g. breakfast).
name*, playlist_id*, days* (1 = Monday … 7 = Sunday), start_time* and end_time* (HH:MM, on :00 or :30), branch_id (leave out for every branch), active (boolean)
PATCH /dayparts/{daypart_id}
Changes a daypart.
name, playlist_id, days, start_time, end_time, branch_id, all_branches (boolean), active (boolean)
DELETE /dayparts/{daypart_id}
Deletes a daypart.
POST /schedules
Shows a playlist between two dates, then goes back to another.
playlist_id*, starts_at* and ends_at* (YYYY-MM-DD HH:MM, on :00 or :30), default_playlist_id*, branch_ids* (list)
PATCH /schedules/{schedule_id}
Changes the dates or the playlist that follows.
starts_at, ends_at, default_playlist_id
DELETE /schedules/{schedule_id}
Deletes a schedule.

On-screen messages

GET /messages
The latest messages and whether they are still showing.
POST /messages
Shows a message over the content, at one branch or at every branch.
body* (max 280), title (max 80), style (info, warning, alert), color (#RRGGBB), branch_id (leave out for every branch), duration_seconds, replaces_message_id
POST /messages/{message_id}/resend
Sends an earlier message again.
DELETE /messages/{message_id}
Takes a message off the screens.

Need something else?

Write to us from the Support page of the panel and tell us what you want to connect.