Mailchimp Campaigns SendCampaign
CertifiedSend a Mailchimp campaign
Mailchimp Campaigns SendCampaign
Send a Mailchimp campaign
Sending a campaign is irreversible: once Mailchimp accepts it, real email goes to the whole audience and cannot be recalled. Only run this on campaigns you have reviewed.
By default (requireReady: true) the task first reads GET /campaigns/{campaignId}/send-checklist and fails, without sending, when is_ready is not true; the failing checklist items are listed in the error. It then calls POST /campaigns/{campaignId}/actions/send (Mailchimp answers 204 without a body).
The send call is never retried after a timeout or a 5xx, so a duplicate send cannot happen (only HTTP 429 is retried). If it fails that way, check the campaign status in Mailchimp before re-running the flow.
Only email contacts who have opted in; you are responsible for GDPR and Mailchimp terms.
type: io.kestra.plugin.mailchimp.campaigns.SendCampaignExamples
WARNING, this really sends the campaign: send it once its checklist is ready.
# WARNING: this flow really sends the campaign to its whole audience and cannot be undone.
id: mailchimp_send_campaign
namespace: company.team
tasks:
- id: send
type: io.kestra.plugin.mailchimp.campaigns.SendCampaign
apiKey: "{{ secret('MAILCHIMP_API_KEY') }}"
campaignId: "a1b2c3d4e5"
requireReady: true
Properties
campaignId *string
Campaign ID
Mailchimp campaign id, found with ListCampaigns.
accessToken string
OAuth access token
Set exactly one of apiKey or accessToken. server is required with an access token.
apiKey string
Mailchimp API key
Set exactly one of apiKey or accessToken. The data center is taken from the key suffix (for example -us19) unless server is set.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
Base URL override
Replaces https://<server>.api.mailchimp.com/3.0. The credential is sent to this URL, so it must be an https *.api.mailchimp.com host.
maxRetries integerstring
3Max retries
Retries done by this plugin on HTTP 429 (all methods) and on 5xx or I/O errors (GET and PUT only), with exponential backoff. Default 3, between 0 and 10. Kestra's HTTP client also replays a GET or PUT once after a 429 or 503 on its own, so 0 only turns off the plugin's retries.
requireReady booleanstring
trueRequire a ready checklist
When true (default), the send checklist must report is_ready before sending. When false the checklist is not called.
server string
Data center
Mailchimp data center such as us19. Required with accessToken, optional with apiKey (overrides the key suffix).
timeout string
PT2MRequest timeout
Idle read timeout of each call: how long to wait without receiving data. Default PT2M, must be positive. Mailchimp itself cuts requests off after 120 seconds.
