For the complete documentation index, see llms.txt. This page is also available as Markdown.

Campaign details

One campaign's content, audience, and progress.

Where: Email → Campaigns → campaign · /projects/<project>/emails/campaigns/<id>/view

The Email Campaign view shows one campaign end to end: its status, what was sent, to whom, through which provider, and how every batch and message did. Drill down batch → message → message log.

Screenshot TODO — capture comes from testing-plan area 13-emails.

What you can do here

General Information — the campaign id (cmp_4RXMBq6T24SOIilOBtkao9, copyable) with a status badge (Pending, Registered, Scheduled, Started, Processing, Completed, Stopped, or Failed), Initiated time with the delivery plan (Instantly, or the scheduled time), the Template (linked to its editor), the Deliver strategy (All users, Specified Users, Specific Email Addresses, or Recipients From a Collection), and whether it delivers with respect to user time zone. A failed campaign shows a Campaign Failed alert with every error message.

The provider block names the email integration the campaign went through, with a See integration details link. Once statistics exist, four tiles show Batches, Sent Emails, Failed, and Success rate.

Actions:

  • Send Now — appears on a scheduled campaign.

  • Stop campaign — appears while the campaign is in flight (Scheduled, Registered, Started, or Processing). Batches already being sent finish; no new recipients are emailed. This cannot be undone.

  • The actions menu adds Create new from this, Export recipients… and Delete campaign… (all enabled once the campaign completes), plus See documentation.

Below, the batches list (filterable by Batch ID) shows each batch with its own status. Opening a batch lists its messages; opening a message shows the message log.

Use it from code

Get Email Campaign · Get Email Campaign Statistics · Stop Email Campaign

API reference

Endpoints: Get Email Campaign, Get Email Campaign Batches, Get Email Campaign Statistics, Stop Email Campaign.

Last updated