@outseta/api-client 0.3.15 → 0.3.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -624,19 +624,27 @@ still be supplied directly (a JSON string of the form
|
|
|
624
624
|
{"BroadcastRecipientsEmailLists":[{"Uid":"..."}],"BroadcastRecipientsSegments":[{"Uid":"..."}]});
|
|
625
625
|
when both are present they are merged.
|
|
626
626
|
|
|
627
|
-
Message.Body is
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
need to understand it. Use Message.PreviewText for inbox preview text rather than an in-body
|
|
627
|
+
Message.Body is rendered as a Liquid template, so it may include merge tags such as
|
|
628
|
+
{{ Person.FirstName }}; unknown {{ }} tokens render as empty text. An inline-styled HTML
|
|
629
|
+
fragment is recommended. Message.Design (the drag-and-drop editor state) is optional — when
|
|
630
|
+
omitted it is derived automatically, so callers (including LLM tools) do not need to
|
|
631
|
+
understand it. Use Message.PreviewText for inbox preview text rather than an in-body
|
|
633
632
|
preheader.
|
|
634
633
|
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
634
|
+
When Body is a bare content fragment (no Design and no unsubscribe token), it is composed
|
|
635
|
+
into the account's API email layout — a branded header and footer that includes the
|
|
636
|
+
unsubscribe and manage-subscriptions links — and the composed result is what is sent and
|
|
637
|
+
opened in the editor. The layout is editable in the app; TemplateUid selects a specific
|
|
638
|
+
layout template when the account has more than one.
|
|
639
|
+
|
|
640
|
+
The layout is NOT applied when the body already contains an unsubscribe token
|
|
641
|
+
({{ UnsubscribeLink }}, {{ UnsubscribeUrl }} or {{ OneClickUnsubscribeUrl }}), when a
|
|
642
|
+
Design is supplied, or when the body is a complex full HTML document (Outlook conditional
|
|
643
|
+
comments, stylesheet links) — in those cases the body is sent exactly as supplied, and you
|
|
644
|
+
must include a visible unsubscribe link in it yourself: add {{ UnsubscribeLink }} (a
|
|
645
|
+
ready-made anchor) or {{ UnsubscribeUrl }} (the raw URL) where you want it. Its presence is
|
|
646
|
+
not validated. A one-click List-Unsubscribe header is always added, but most anti-spam laws
|
|
647
|
+
(e.g. CAN-SPAM) also require a visible unsubscribe link in the body.
|
|
640
648
|
* @summary Create a new broadcast.
|
|
641
649
|
*/
|
|
642
650
|
export type campaignAddBroadcastEmailResponse200 = {
|
|
@@ -742,8 +750,11 @@ set, send RecipientData directly.
|
|
|
742
750
|
|
|
743
751
|
When changing Message.Body, omit Message.Design: it is regenerated from the new Body so the
|
|
744
752
|
drag-and-drop editor stays in sync. Sending a Design that was captured from an earlier
|
|
745
|
-
response alongside an edited Body would otherwise keep the stale design.
|
|
746
|
-
|
|
753
|
+
response alongside an edited Body would otherwise keep the stale design. A body that was
|
|
754
|
+
composed into the API email layout keeps the layout on such updates without duplicating
|
|
755
|
+
it — its content is re-composed into the layout — and a bare fragment is composed like on
|
|
756
|
+
create. See the create endpoint for how Body is rendered (Liquid), when the layout
|
|
757
|
+
applies, and the unsubscribe-token expectation when it does not.
|
|
747
758
|
* @summary Update a broadcast.
|
|
748
759
|
*/
|
|
749
760
|
export type campaignUpdateBroadcastEmailResponse200 = {
|