Help Center

Published messages and templates

See API introduction for authentication, request conventions, pagination, rate limits, and errors.

Both list endpoints are always paginated: per_page defaults to 10. Use page to continue.

In Activity Messenger, newsletters can be published from either a template or a sent message. A published template can be modified whereas a published message cannot. Read this help page to find out more: Newsletters. Use these API endpoints to retrieve all published messages and templates.

GET /api/v1/organization/{organization}/published_messages

Retrieves a list of all published sent messages ordered by published date (last first).

GET /api/v1/organization/{organization}/published_templates

Retrieves a list of all published templates ordered by published date (last first).

Each item exposes the fields described below.

Each item includes id, name, subject, url, short_url, published_at, created_at, updated_at, styling fields, and blocks.

The url attribute points to the message/template as a web page. The HTML is simple and contains no JavaScript and no external CSS files.

The background_color and background_image attributes define the background color outside of the template (usually dark gray), or an image.

The content_background_color attribute defines the content background color. The button_color defines the default button color. It could be overridden in each block.

The blocks attribute is a list of vertical blocks that compose the message/template. Blocks can be used to reconstruct the template with your own CSS styling and HTML markup. These are the blocks currently supported and the attributes they use:

• hero: Hero image. Use attributes: image_url, image_alt.
• one-column: Single column of text with an optional button. Use attributes: text, button_url, button_text, button_color, button_target (https (default) or mailto).
• image-column: Two columns with an image left and text right with an optional button. Use attributes: image_url, image_alt, image_cta_url (URL to go to if user clicks on image), text, button_url, button_text, button_color, button_target (https (default) or mailto).
• column-image: Two columns with text left with an optional button, and image right. Use attributes: image_url, image_alt, image_cta_url (URL to go to if user clicks on image), text, button_url, button_text, button_color, button_target (https (default) or mailto).
• spacer: Horizontal spacer. Attribute meta contains CSS styles to create the spacer.
• video: Hero video preview with a link to open the video in another browser tab. Use attributes: image_url (video preview image), image_alt, image_cta_url (URL to video).
• video-column: Two columns with a video preview left and text right with an optional button. Use attributes: image_url (preview of the video), image_alt, image_cta_url (URL to video), text, button_url, button_text, button_color, button_target (https (default) or mailto).
• two-columns: Two columns with text each with an optional image, and an optional button. For the left column use attributes: image_url, image_alt, image_cta_url (URL to go to if user clicks on image), text, button_url, button_text, button_color, button_target (https (default) or mailto). For the right column, use the ones post-fixed with 2.