object'newsletter' required
audience_idstring nullable required
sender_identity_idstring nullable required
newsletter_domain_idstring nullable required
preview_textstring nullable
reply_to_addressstring nullable
body_htmlstring nullable
Rendered email HTML, derived from blocks for drafts. Read-only.
body_textstring nullable
Plain-text body, derived from blocks unless a manual override was set. Read-only.
status'draft' | 'imported' | 'pending_approval' | 'approved' | 'scheduled' | 'sending' | 'paused' | 'sent' | 'cancelled' | 'failed' required
archive_visibility'private' | 'public' required
feed_entry_urlstring uri nullable required
Optional http(s) Atom entry destination. Feed readers link the newsletter title here instead of to its Shipmail web archive, including when the archive is private.
styling_mode'styled' | 'plain' required
styled applies Shipmail's email theme. plain sends your HTML without injected styles, width, or centering, so the reader's email client styles it.
track_engagementboolean required
Whether this newsletter tracks opens and clicks.
add_utm_tagsboolean required
Whether this newsletter adds UTM tags to its links. Adds utm_source=shipmail, utm_medium (email or feed) and utm_campaign (a slug of the subject) to the newsletter's http and https links. Links that already carry a utm_ parameter, links with a merge tag in the host, and Shipmail's own unsubscribe and archive links are left alone. The web archive is never tagged.
opened_countinteger nullable required
Unique recipients with at least one counted open. Opens that Apple Mail Privacy Protection preloads are not counted. Null when track_engagement is false.
clicked_countinteger nullable required
Unique recipients who clicked at least one tracked link, excluding clicks attributed to link scanners. Null when track_engagement is false.
send_limitinteger nullable required
The limit the newsletter was scheduled with: only this many of the most engaged subscribers went first. Null sends to everyone.
held_countinteger required
Subscribers held past send_limit. Send them the newsletter with POST /newsletters/{id}/send-more.
subject_bstring nullable required
A second subject tested against subject. Requires track_engagement.
subject_test_percentinteger nullable
The share of subscribers each subject goes to first, from 1 to 25. Null when there is no subject test.
subject_test_hoursinteger nullable
Hours after both test slices finish before the subject with more human clicks goes to the rest, from 1 to 72.
subject_test_winner'a' | 'b' | 'null' nullable required
a is subject, b is subject_b. Null until the test decides. A tie keeps a.
subject_test_decided_atstring date-time nullable
preflight_status'not_run' | 'passed' | 'warning' | 'failed' required
send_rate_per_hourinteger
scheduled_atstring date-time nullable
approved_atstring date-time nullable
started_atstring date-time nullable
published_atstring date-time nullable required
Stable first-publication timestamp.
archive_urlstring uri nullable required
Canonical Shipmail public archive URL.
completed_atstring date-time nullable
cancelled_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required
last_test_sent_atstring date-time nullable
last_test_recipientstring nullable
content_changed_since_test_sendboolean