Update a newsletter
update_newsletterChanges a draft or ready newsletter: name, audience, subject, preheader or body fields, or marks it ready (ready: true) or back to draft. Changing a body field rebuilds the body from the plain fields, replacing block edits made in the editor; subject, preheader and audience changes keep the body. Pass document to replace the whole email document as get_newsletter returns it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| html | No | Optional: a full HTML body instead of the blocks (it is sanitized; the brand header, address and unsubscribe footer are added). | |
| name | No | ||
| ready | No | true marks it ready to schedule or use in a journey; false back to draft. | |
| title | No | The headline. | |
| ctaUrl | No | Button link (https). | |
| layout | No | ||
| eyebrow | No | Small line above the title. | |
| signoff | No | Closing line. | |
| subject | No | Subject line. | |
| audience | No | Who it goes to: contacts in ANY (match "any") or ALL (match "all") of the included segments, tags and filters, minus the excluded ones. Nothing included means every contact of the product. Consent and suppressions are always applied on top. | |
| ctaLabel | No | Button label. | |
| document | No | Optional: the complete email document (as get_newsletter returns it). | |
| sections | No | Body sections, each with a heading and body text. | |
| subjectB | No | Optional second subject for an A/B test (half the audience gets each). | |
| preheader | No | Preview text after the subject. | |
| productId | No | Product id, or null for every product. | |
| campaignId | Yes | Newsletter id from list_newsletters. | |
| introduction | No | Opening paragraph(s). {{first_name}} and other merge tags work. |