Pular para o conteúdo principal

Templates e notificações

Os templates e layouts dos e-mails que a plataforma envia, e as notificações — criadas, enviadas e acompanhadas.

Famílias nesta página​

FamíliaToolsreadwritedestructive
templates — Templates de e-mail15573
notifications — Notificações4202

templates​

ToolTipoPermissãoEndpointO que faz
dashboards_email_templates_listreadtemplates.listGET /v1/email_templatesList the organization's own e-mail templates, ordered by type and name.
dashboards_email_templates_getreadtemplates.showGET /v1/email_templates/:idFetch one e-mail template by id — subject, HTML and text bodies, BCC list, variables and active flag.
dashboards_email_templates_createwritetemplates.createPOST /v1/email_templatesCreate 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_updatewritetemplates.updatePATCH /v1/email_templates/:idUpdate one of the organization's e-mail templates — name, subject, bodies, BCC, variables or active flag.
dashboards_email_templates_deletedestructivetemplates.deleteDELETE /v1/email_templates/:idDelete an inactive e-mail template of the organization for good.
dashboards_email_templates_duplicatewritetemplates.createPOST /v1/email_templates/:id/duplicateCopy an e-mail template as an inactive draft, named new_name or "<name> (Cópia)".
dashboards_email_templates_previewreadtemplates.showGET /v1/email_templates/:id/previewRender an e-mail template with built-in sample data, wrapped in the organization layout, without sending anything.
dashboards_email_templates_renderwritetemplates.updatePOST /v1/email_templates/:id/previewRender an e-mail template with your own variables (no layout), without sending anything.
dashboards_email_templates_init_defaultsdestructivetemplates.createPOST /v1/email_templates/init_defaultsReset 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_listreadtemplates.listGET /v1/email_layoutsList 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_getreadtemplates.showGET /v1/email_layouts/:idFetch one e-mail layout by id — name, HTML, default and active flags.
dashboards_email_layouts_createwritetemplates.createPOST /v1/email_layoutsCreate an e-mail layout.
dashboards_email_layouts_updatewritetemplates.updatePATCH /v1/email_layouts/:idUpdate an e-mail layout — name, HTML (must keep {{content}}), default or active flag.
dashboards_email_layouts_deletedestructivetemplates.deleteDELETE /v1/email_layouts/:idDelete an e-mail layout for good.
dashboards_email_layouts_init_defaultswritetemplates.createPOST /v1/email_layouts/init_defaultsMake sure the organization has a default e-mail layout: returns the current default, or creates the built-in one.

notifications​

ToolTipoPermissãoEndpointO que faz
dashboards_notifications_listreadnotifications.listGET /v1/notificationsList the notifications (e-mails and other messages) of the workspace and the organization, newest first.
dashboards_notifications_statsreadnotifications.listGET /v1/notifications/statsCount the notifications created in the last days days (default 30) by status, type and channel, with the delivery and read rates.
dashboards_notifications_createdestructivenotifications.updatePOST /v1/notificationsSend 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_senddestructivenotifications.updatePOST /v1/notifications/:id/sendSend 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.

Os campos de cada recurso estão na Referência da API e em dashboards_schemas_get.

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.