StatusDashboard
Templates

Update template

Full replacement of a template's mutable playbook fields.

View Markdown

PUT /app/templates/{id}

Full replacement (PUT semantics). Requires the templates plan feature and admin or event role.

eventType is immutable — omit it from the body or send the same value; mismatch returns 400.


Path parameters

ParameterTypeDescription
idstring (UUID)Template ID.

Request

See API Basics for required headers.

Request body

Same playbook fields as Create template, except:

  • Do not send eventType (or it must match the stored value).
  • notifications is required on update.

Sample request

curl -X PUT https://api.statusdashboard.com/app/templates/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Database outage playbook",
    "title": "Database connectivity issues",
    "description": "We are investigating database connectivity problems.",
    "notifications": true
  }'

Sample response

Status: 200 OK

{
  "template": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Database outage playbook",
    "eventType": "incident",
    "title": "Database connectivity issues",
    "description": "We are investigating database connectivity problems.",
    "notifications": true,
    "updatedAt": "2026-04-01T08:00:00.000Z"
  }
}

Error responses

StatusWhen
400Validation failure, immutable eventType mismatch, or rejected instance fields present.
403Templates feature not enabled or insufficient role.
404Template not found in this organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.