Skip to main content

Email layouts

The HTML frame (header, footer, styles) e-mail templates are placed into. init-defaults create makes sure a default layout exists, without overwriting any.

CommandHTTPDescription
email-layouts listGET /v1/email_layoutsList email layouts
email-layouts createPOST /v1/email_layoutsCreate email layout
email-layouts getGET /v1/email_layouts/{id}Get email layout
email-layouts updatePATCH /v1/email_layouts/{id}Update email layout
email-layouts deleteDELETE /v1/email_layouts/{id}Delete email layout
email-layouts init-defaults createPOST /v1/email_layouts/init_defaultsCreate default layout

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List email layouts
kobana dashboards email-layouts list --fields "id,name,is_default,is_active"

# Create default layout
kobana dashboards email-layouts init-defaults create

# Update email layout
kobana dashboards email-layouts update \
--params '{"id": "LAYOUT_ID"}' \
--json '{"is_default": true}'

Next steps​