Templates and notifications

The templates and layouts of the e-mails the platform sends, and the notifications — created, sent and tracked.

Families on this page

Family	Tools	read	write	destructive
templates — E-mail templates	15	5	7	3
notifications — Notifications	4	2	0	2

templates

Tool	Kind	Permission	Endpoint	What it does
dashboards_email_templates_list	read	templates.list	GET /v1/email_templates	List the organization's own e-mail templates, ordered by type and name.
dashboards_email_templates_get	read	templates.show	GET /v1/email_templates/:id	Fetch one e-mail template by id — subject, HTML and text bodies, BCC list, variables and active flag.
dashboards_email_templates_create	write	templates.create	POST /v1/email_templates	Create an e-mail template for a notification type (api_key_expiring, account_suspended or account_activated — e-mails carrying a sign-in link or code always use the platform content, 422 TEMPLATE_TYPE_NOT_EDITABLE).
dashboards_email_templates_update	write	templates.update	PATCH /v1/email_templates/:id	Update one of the organization's e-mail templates — name, subject, bodies, BCC, variables or active flag.
dashboards_email_templates_delete	destructive	templates.delete	DELETE /v1/email_templates/:id	Delete an inactive e-mail template of the organization for good.
dashboards_email_templates_duplicate	write	templates.create	POST /v1/email_templates/:id/duplicate	Copy an e-mail template as an inactive draft, named new_name or "<name> (Cópia)".
dashboards_email_templates_preview	read	templates.show	GET /v1/email_templates/:id/preview	Render an e-mail template with built-in sample data, wrapped in the organization layout, without sending anything.
dashboards_email_templates_render	write	templates.update	POST /v1/email_templates/:id/preview	Render an e-mail template with your own variables (no layout), without sending anything.
dashboards_email_templates_init_defaults	destructive	templates.create	POST /v1/email_templates/init_defaults	Reset the organization's template of every notification type to the shipped default and activate it — creating missing ones and OVERWRITING the content of existing ones.
dashboards_email_layouts_list	read	templates.list	GET /v1/email_layouts	List the organization's e-mail layouts (the HTML shell e-mails are wrapped in — never those carrying a sign-in link or code, which use the platform layout), default first.
dashboards_email_layouts_get	read	templates.show	GET /v1/email_layouts/:id	Fetch one e-mail layout by id — name, HTML, default and active flags.
dashboards_email_layouts_create	write	templates.create	POST /v1/email_layouts	Create an e-mail layout.
dashboards_email_layouts_update	write	templates.update	PATCH /v1/email_layouts/:id	Update an e-mail layout — name, HTML (must keep {{content}}), default or active flag.
dashboards_email_layouts_delete	destructive	templates.delete	DELETE /v1/email_layouts/:id	Delete an e-mail layout for good.
dashboards_email_layouts_init_defaults	write	templates.create	POST /v1/email_layouts/init_defaults	Make sure the organization has a default e-mail layout: returns the current default, or creates the built-in one.

notifications

Tool	Kind	Permission	Endpoint	What it does
dashboards_notifications_list	read	notifications.list	GET /v1/notifications	List the notifications (e-mails and other messages) of the workspace and the organization, newest first.
dashboards_notifications_stats	read	notifications.list	GET /v1/notifications/stats	Count the notifications created in the last days days (default 30) by status, type and channel, with the delivery and read rates.
dashboards_notifications_create	destructive	notifications.update	POST /v1/notifications	Send a notification to recipient: renders the organization's active template of type (or the platform default) with variables, stores it and sends it right away — the returned notification is sent, or failed with its failure_reason.
dashboards_notifications_send	destructive	notifications.update	POST /v1/notifications/:id/send	Send a stored notification now — the first send of a pending (scheduled) or skipped one, or a resend of a sent, delivered, read or failed one.

---

The fields of each resource are in the API reference and in dashboards_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.