My email campaigns
email_campaignsThe workspace's email campaigns - one message to a list of people (Email Connections). action list: every campaign. get: one with its recipient tally. create: draft a campaign; it is saved as a DRAFT and nothing is sent until the workspace owner approves it in the Email console. status: how a campaign is doing (sent, delivered, opened, clicked, bounced, unsubscribed). An A/B test is part of a campaign: pass variants (two or more versions of the subject or body) and abTest on create.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | create: the sender, on a domain this workspace has connected and verified. | |
| html | No | create: the HTML body. May use {{tags}}. | |
| name | No | create: an internal name, e.g. 'September newsletter'. | |
| text | No | create: the plain-text body. May use {{tags}}. | |
| abTest | No | create, with variants: testPercent (1-50, default 20), metric (clicks, replies, opens or manual) and waitHours (1-72, default 24). | |
| action | Yes | What to do with campaigns: list, get, create or status. | |
| listId | No | create: send to a list from the contact book. | |
| person | No | Linked person to run this call as (first name). Omit to run as the connection's holder. | |
| project | No | Workspace to run this call in (id or name). | |
| replyTo | No | create: where replies should go, when that is not the sender. | |
| subject | No | create: the subject line. May use {{tags}}. | |
| variants | No | create: the A/B versions, each a {subject, html, text} object. | |
| segmentId | No | create: send to a saved segment. | |
| campaignId | No | get and status: the campaign. | |
| postalAddress | No | create: the postal address printed in every footer (bulk-mail law). |