v1

latestOpenAPI 3.1.02026-07-24334970.2 KB

Templates

Create a template

Creates a new HTML template for waiting room pages. Must be a complete HTML5 document (<!DOCTYPE html>, closing </body></html>). Limited to 50 KB.

post/templates

Request body

namestring required

Name of the template.

templatestring required

HTML content for the waiting room page. Must be a complete HTML5 document: <!DOCTYPE html>, <html>, <head>, <body>, and explicit </body> then </html>. Limited to 50 KB.

Example request

{
  "name": "Sale Event Theme",
  "template": "<!DOCTYPE html><html><head><title>Please wait</title></head><body><h1>You are in the queue</h1></body></html>"
}

Response

Successfully created template.

idstring uuid

System-generated unique identifier for the template.

namestring

Name of the template.

templatestring

The customer-facing HTML content of the waiting room page. Limited to 50 KB. Must be a complete HTML5 document: <!DOCTYPE html>, <html>, <head>, <body>, and explicit </body> then </html>.

assignedPrioritiesCountinteger

Number of priorities currently using this template.

createdAtstring date-time

Timestamp when the template was created (ISO 8601 UTC).

updatedAtstring date-time

Timestamp when the template was last updated (ISO 8601 UTC).

Example response

{
  "id": "c1d2e3f4-5678-9abc-def0-123456789abc",
  "name": "Black Friday Theme",
  "template": "<!DOCTYPE html><html><head><title>Please wait</title></head><body>...</body></html>",
  "assignedPrioritiesCount": 2,
  "createdAt": "2025-10-01T12:00:00Z",
  "updatedAt": "2025-10-15T09:30:00Z"
}