EngageMessage
A broadcast / engage campaign — a scheduled or one-off message sent to a segment, tag, or list of customers over email, messenger, push, or WhatsApp.
Create with engageMessageAdd, run its lifecycle with
engageMessageStart / engageMessagePause /
engageMessageResume / engageMessageStop,
and inspect delivery with engageReportsList,
engageWhatsappDeliveries, or engageLogs.
Only one of email, messenger, push, or whatsappMessage is populated, matching method.
EngageMessageFields
Unique campaign identifier.
Campaign type, e.g. auto, visitorAuto, manual. See kind filter on engageMessages.
Conversation/message tags targeted for automation-kind campaigns.
Customer tags used to build the audience. Resolved to names via customerTags.
Segment v2 ids used to build the audience. Resolved to names via segments.
Explicit customer ids included in the audience, in addition to segments/tags.
Campaign name shown in the dashboard and engageMessages search.
Team member id the campaign is sent as. Resolved via fromUser.
Delivery channel: email, messenger, push, or whatsapp. Determines which of email / messenger / push / whatsappMessage is set.
Lifecycle status, e.g. draft, live, paused, yet, failed. Advance with engageMessageStart and friends.
When this campaign was created.
Customer ids that have received a messenger-kind campaign so far.
Total audience size resolved at send time.
Audience size after removing invalid / unreachable recipients (e.g. missing email/phone).
Number of messages sent so far across all runs.
Number of messages that failed to send across all runs.
Number of recipients processed so far (sent + failed + skipped).
How many times this campaign has run (relevant for recurring schedules).
Timestamp of the most recent run.
When the current or most recent run started.
When the most recent run finished successfully.
When the campaign was stopped via engageMessageStop.
Most recent send-time error message, if any.
Total number of send batches for the current run.
Number of send batches completed for the current run.
Status the campaign was in before it was paused, restored by engageMessageResume.
History of individual run summaries. See EngageRunSummary.
Email content and headers when method is email. See EngageMessageEmail shape (input-only type; returned as JSON).
Messenger content and rules when method is messenger (returned as JSON).
WhatsApp template configuration when method is whatsapp. See EngageMessageWhatsapp.
Automation namespace this campaign was created from, if triggered by an automation.
Push notification content when method is push (returned as JSON).
User id who created the campaign.
Send schedule — once or recurring. See EngageScheduleDate.
Resolved segment names for segmentIds. See EngageSegment.
Resolved customer tag names for customerTagIds. See EngageAudienceTag.
Resolved conversation/message tags for tagIds.
Resolved team member for fromUserId.
Resolved integration used to send WhatsApp/messenger content (returned as JSON).
Display name of the creator, for list views.
Aggregate email delivery stats for this campaign (returned as JSON). See AvgEmailStats for the shape of workspace-wide averages.
Aggregate WhatsApp delivery stats for this campaign (returned as JSON). See AvgWhatsappStats for the shape of workspace-wide averages.
Aggregate push delivery stats for this campaign. See EngagePushStats.
Recent execution logs. Prefer engageLogs for paginated access.
مواضيع ذات صلة
engageMessagesengageMessageDetailengageMessageEditEngageMessageWhatsappengageMessageRemove