Skip to content

Listmonk settings

Listmonk is a newsletter, so a Sharek post to a Listmonk channel creates a campaign rather than a social post. The post’s content is the email body.

Field Required Description
subject Yes The email subject line. At least one character.
preview Yes Preview text, the line shown after the subject in an inbox. May be an empty string.
list Yes The list id to send to.
template No The template id to render with.
"settings": {
"subject": "What we shipped in September",
"preview": "A new calendar, faster analytics, and more",
"list": "3",
"template": "5"
}
  • list and template are ids, not names.
  • preview is required as a field but accepts an empty string, so send "" if you do not want preview text.
  • Write the email body as HTML in the post’s content.
  • Pictures go inside the body as <img src="...">, where you want them in the email. Each src must be a picture from your media library, so upload it first with upload a file.
  • Attachments in the post’s value[].image are not sent.
  • Listmonk channels are connected with a URL, username and password that you supply.

Send these under settings in create a post. Read a channel’s live schema with channel settings. Connect the channel first: connecting your channels.