The campaign is born a draft, for the whole list, with the list’s sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \ --url https://api.lekalao.com/v1/campaigns \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Christmas offer", "subject": "Hello {{ subscriber.first_name }}, the Yule logs are here", "list": "9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12", "editor": "html", "content": "<p>Hello {{ subscriber.first_name }},</p><p>Our Yule logs are out of the oven. <a href=\"https://mybakery.example/christmas\">Order yours</a></p><p><a href=\"{{ unsubscribe_url }}\">Unsubscribe</a><br>{{ organisation.address }}</p>"}'
{
"message": "The idempotency key is too long.",
"code": "idempotency_key_too_long",
"doc_url": "https://docs.lekalao.com/errors#idempotency_key_too_long"
}
{
"message": "This team is suspended. Contact support.",
"code": "team_suspended",
"doc_url": "https://docs.lekalao.com/errors#team_suspended"
}
{
"message": "A request with this idempotency key is already running.",
"code": "idempotency_key_in_use",
"doc_url": "https://docs.lekalao.com/errors#idempotency_key_in_use"
}
{
"message": "The email field must be a valid email address.",
"code": "validation_error",
"doc_url": "<string>",
"errors": {},
"problem": "disposable",
"suggestion": "jsmith@example.com"
}
{
"message": "Too many requests. Try again in 12 seconds.",
"code": "rate_limited",
"doc_url": "https://docs.lekalao.com/errors#rate_limited"
}
Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true). Read on POST, PUT and PATCH; DELETE ignores it. 255 characters at most.
{
"message": "The idempotency key is too long.",
"code": "idempotency_key_too_long",
"doc_url": "https://docs.lekalao.com/errors#idempotency_key_too_long"
}
{
"message": "This team is suspended. Contact support.",
"code": "team_suspended",
"doc_url": "https://docs.lekalao.com/errors#team_suspended"
}
{
"message": "A request with this idempotency key is already running.",
"code": "idempotency_key_in_use",
"doc_url": "https://docs.lekalao.com/errors#idempotency_key_in_use"
}
{
"message": "The email field must be a valid email address.",
"code": "validation_error",
"doc_url": "<string>",
"errors": {},
"problem": "disposable",
"suggestion": "jsmith@example.com"
}
{
"message": "Too many requests. Try again in 12 seconds.",
"code": "rate_limited",
"doc_url": "https://docs.lekalao.com/errors#rate_limited"
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Lekalao","description":"Lekalao documentation: lists, campaigns, automations and transactional e-mails.","colors":{"primary":"#006C4D","light":"#47C496","dark":"#008060"},"logo":{"light":"https://mintcdn.com/lekalao/X2dfnmUN5ikXeFCy/logo/light.svg?fit=max\u0026auto=format\u0026n=X2dfnmUN5ikXeFCy\u0026q=85\u0026s=2e6970b4e9a452195680476cf2c13687","dark":"https://mintcdn.com/lekalao/X2dfnmUN5ikXeFCy/logo/dark.svg?fit=max\u0026auto=format\u0026n=X2dfnmUN5ikXeFCy\u0026q=85\u0026s=6560301026053212e4e4b88ada215e4f","href":"/"},"favicon":"https://mintcdn.com/lekalao/X2dfnmUN5ikXeFCy/favicon.svg?fit=max\u0026auto=format\u0026n=X2dfnmUN5ikXeFCy\u0026q=85\u0026s=9d16d9b36295db2acb313ac42b51dd0d","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","php","python"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#FCF9F1","dark":"#06170F"}},"navbar":{"links":[{"href":"/api-reference/introduction","label":"API reference"}],"primary":{"type":"button","label":"Get started","href":"/guide/quickstart"}},"footer":{"socials":{}},"seo":{"metatags":{"og:site_name":"Lekalao","og:locale":"en_GB","twitter:card":"summary_large_image","keywords":"Lekalao, e-mail marketing, newsletter, transactional e-mail, e-mail API, campaigns, automations, deliverability"},"paths":[{"path":"fr","metatags":{"og:locale":"fr_FR","keywords":"Lekalao, e-mailing, newsletter, e-mail transactionnel, API e-mail, campagnes, automatisations, délivrabilité"}}],"organization":{"name":"Lekalao","url":"https://lekalao.com"},"indexing":"navigable"},"fonts":{"heading":{"family":"Fraunces","weight":500},"body":{"family":"Instrument Sans"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"navigation":{"languages":[{"language":"en","default":true,"href":""},{"language":"fr","navbar":{"links":[{"href":"/fr/api-reference/introduction","label":"Référence API"}],"primary":{"type":"button","label":"Démarrer","href":"/fr/guide/quickstart"}},"href":"fr"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lekalao","hasAudioNarration":false,"actualSubdomain":"lekalao","customDomains":["docs.lekalao.com"],"gitSource":{"type":"github","owner":"lekalao","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae68330f80d76da9487939b","collectionId":"059f732d-9ac0-4667-aefd-436ad26fc4f5","liveDeploymentHistoryId":"6ae68330f80d76da9487939b","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae68330f80d76da9487939b","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"en","tag":"API reference","count":59},{"language":"fr","tag":"Référence API","count":59},{"language":"en","tag":"User guide","count":50},{"language":"fr","tag":"Guide utilisateur","count":50},{"language":"en","tag":"Developers","count":18},{"language":"fr","tag":"Développeurs","count":18},{"language":"en","tag":"Campaigns","count":11},{"language":"en","tag":"Contacts","count":11},{"language":"fr","tag":"Campagnes","count":11},{"language":"fr","tag":"Contacts","count":11},{"language":"en","tag":"Subscribers","count":10},{"language":"fr","tag":"Abonnés","count":10},{"language":"en","tag":"Content","count":8},{"language":"fr","tag":"Contenu","count":8},{"language":"en","tag":"Account and team","count":7},{"language":"en","tag":"Recipes","count":7},{"language":"en","tag":"Transactional e-mails","count":7},{"language":"fr","tag":"Compte et équipe","count":7},{"language":"fr","tag":"Recettes","count":7},{"language":"fr","tag":"E-mails transactionnels","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area h2,#content-area h3,#page-title{font-weight:500;letter-spacing:-.015em}#page-title{overflow-wrap:break-word;word-break:normal}#table-of-contents h2,nav h2{font-family:'Instrument Sans',system-ui,sans-serif;font-weight:600;font-size:.8125rem}#content-area{max-width:42rem}.frame{background:#f5f0e4;border:1px solid rgb(11 34 25/.1)}.dark .frame{background:rgb(255 255 255/.04);border-color:rgb(255 255 255/.1)}.frame img{border-radius:.625rem}"}],"page":{"pagePath":"api-reference/campaigns/create-a-campaign","slug":"/api-reference/campaigns/create-a-campaign","pageMetadata":{"title":"Create a campaign","description":"The campaign is born a draft, for the whole list, with the list's sender. To be sent, its content (or its template) must carry `{{ unsubscribe_url }}` and `{{ organisation.address }}`, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"The campaign is born a draft, for the whole list, with the list’s sender. To be sent, its content (or its template) must carry \", _jsx(_components.code, {\n children: \"{{ unsubscribe_url }}\"\n }), \" and \", _jsx(_components.code, {\n children: \"{{ organisation.address }}\"\n }), \", and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a campaign","description":"The campaign is born a draft, for the whole list, with the list's sender. To be sent, its content (or its template) must carry `{{ unsubscribe_url }}` and `{{ organisation.address }}`, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Campaigns"],"summary":"Create a campaign","operationId":"api.campaigns.store","description":"The campaign is born a draft, for the whole list, with the list's sender. To be sent, its content (or its template) must carry `{{ unsubscribe_url }}` and `{{ organisation.address }}`, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.","parameters":["6336e221-917d-4599-bd02-5e69441781e5"],"requestBody":"0846549f-329d-46ee-a68a-a6a66feee987","responses":{"201":"c4ca2b16-5b4c-4a3a-9c17-a2f551d10f52","400":"4a713d57-6c5f-4845-be02-45e5d7c31a1e","401":"d25608a2-401c-44b7-a9eb-96570c69b924","403":"38f1223f-ac2a-46b7-8d99-74271b28ae7b","409":"47dfd4f8-3e13-4ec3-b1ef-76ec06e38dd2","422":"ebfa9d63-99e7-4955-91c2-fce35b9ffbbb","429":"5cd5aaca-9d0d-4f29-b7b3-db2632e15c78"},"method":"post","type":"path","servers":["625bf61b-f921-4af5-aee2-6126e1725dc5","6265c5f9-182f-47e2-b539-473ca46cdc4b"],"security":["87f09f49-73ef-4e5f-9063-0e3c9d075c26"],"path":"/v1/campaigns","baseUrlOptions":["https://api.lekalao.com","https://{host}/api"],"title":"Create a campaign","codeSamples":[],"requestExampleLanguages":["bash","javascript","php","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6336e221-917d-4599-bd02-5e69441781e5":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Replay a write safely: the same key gives back the first answer for 24 hours (header `Idempotent-Replay: true`). Read on POST, PUT and PATCH; DELETE ignores it. 255 characters at most.","uniqueKey":"","typeLabel":"string"},"description":"Replay a write safely: the same key gives back the first answer for 24 hours (header `Idempotent-Replay: true`). Read on POST, PUT and PATCH; DELETE ignores it. 255 characters at most."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","list","editor"],"properties":{"name":{"type":"string","maxLength":255,"description":"Seen by the team only.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"list":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"list","typeLabel":"string\u003cuuid>"},"editor":{"type":"string","enum":["blocks","markdown","html","mjml"],"isRequired":true,"uniqueKey":"editor","typeLabel":"enum\u003cstring>"},"subject":{"oneOf":[{"type":"string","maxLength":255,"uniqueKey":"subject.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"uniqueKey":"subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"subject","typeLabel":"string | null"},"content":{"oneOf":[{"type":"string","description":"500,000 characters at most. For \"blocks\", the editor's JSON document.","uniqueKey":"content.oneOf.0","typeLabel":"string"},{"type":"null","description":"500,000 characters at most. For \"blocks\", the editor's JSON document.","uniqueKey":"content.oneOf.1","typeLabel":"null"}],"uniqueKey":"content","typeLabel":"string | null"},"track_opens":{"type":"boolean","default":true,"uniqueKey":"track_opens","typeLabel":"boolean"},"track_clicks":{"type":"boolean","default":true,"uniqueKey":"track_clicks","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"Christmas offer","subject":"Hello {{ subscriber.first_name }}, the Yule logs are here","list":"9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12","editor":"html","content":"\u003cp>Hello {{ subscriber.first_name }},\u003c/p>\u003cp>Our Yule logs are out of the oven. \u003ca href=\"https://mybakery.example/christmas\">Order yours\u003c/a>\u003c/p>\u003cp>\u003ca href=\"{{ unsubscribe_url }}\">Unsubscribe\u003c/a>\u003cbr>{{ organisation.address }}\u003c/p>"},"examples":{"Example":{"title":"Example","value":{"name":"Christmas offer","subject":"Hello {{ subscriber.first_name }}, the Yule logs are here","list":"9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12","editor":"html","content":"\u003cp>Hello {{ subscriber.first_name }},\u003c/p>\u003cp>Our Yule logs are out of the oven. \u003ca href=\"https://mybakery.example/christmas\">Order yours\u003c/a>\u003c/p>\u003cp>\u003ca href=\"{{ unsubscribe_url }}\">Unsubscribe\u003c/a>\u003cbr>{{ organisation.address }}\u003c/p>"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"c4ca2b16-5b4c-4a3a-9c17-a2f551d10f52":{"description":"The campaign that was created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"data.name","typeLabel":"string"},"subject":{"oneOf":[{"type":"string","uniqueKey":"data.subject.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subject","typeLabel":"string | null"},"status":{"type":"string","enum":["draft","scheduled","sending","paused","sent","cancelled"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"list":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.list.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.list.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.list","typeLabel":"string\u003cuuid> | null"},"scheduled_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.scheduled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.scheduled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.scheduled_at","typeLabel":"string\u003cdate-time> | null"},"sent_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.sent_at","typeLabel":"string\u003cdate-time> | null"},"statistics":{"type":"object","properties":{"recipients":{"oneOf":[{"type":"integer","uniqueKey":"data.statistics.recipients.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.statistics.recipients.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.statistics.recipients","typeLabel":"integer | null"},"sent":{"type":"integer","uniqueKey":"data.statistics.sent","typeLabel":"integer"},"delivered":{"type":"integer","description":"Confirmed by the provider (its feedback webhook).","uniqueKey":"data.statistics.delivered","typeLabel":"integer"},"opens":{"type":"integer","uniqueKey":"data.statistics.opens","typeLabel":"integer"},"unique_opens":{"type":"integer","uniqueKey":"data.statistics.unique_opens","typeLabel":"integer"},"clicks":{"type":"integer","uniqueKey":"data.statistics.clicks","typeLabel":"integer"},"unique_clicks":{"type":"integer","uniqueKey":"data.statistics.unique_clicks","typeLabel":"integer"},"bounces":{"type":"integer","uniqueKey":"data.statistics.bounces","typeLabel":"integer"},"complaints":{"type":"integer","uniqueKey":"data.statistics.complaints","typeLabel":"integer"},"unsubscribes":{"type":"integer","uniqueKey":"data.statistics.unsubscribes","typeLabel":"integer"}},"uniqueKey":"data.statistics","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","subject":"\u003cstring>","status":"draft","list":"3c90c3cc-0d44-4b50-8888-8dd25736052a","scheduled_at":"2023-11-07T05:31:56Z","sent_at":"2023-11-07T05:31:56Z","statistics":{"recipients":123,"sent":123,"delivered":123,"opens":123,"unique_opens":123,"clicks":123,"unique_clicks":123,"bounces":123,"complaints":123,"unsubscribes":123},"created_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4a713d57-6c5f-4845-be02-45e5d7c31a1e":{"description":"The `Idempotency-Key` is longer than 255 characters.","content":{"application/json":{"schema":{"type":"object","required":["message","code","doc_url"],"properties":{"message":{"type":"string","description":"A sentence for a person, in the installation's language. It may be reworded: test `code`, not the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"description":"What went wrong, in one stable snake_case word. Each one is explained at `doc_url`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"The page of the documentation that explains this code.","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The idempotency key is too long.","code":"idempotency_key_too_long","doc_url":"https://docs.lekalao.com/errors#idempotency_key_too_long"},"examples":{"Example":{"title":"Example","value":{"message":"The idempotency key is too long.","code":"idempotency_key_too_long","doc_url":"https://docs.lekalao.com/errors#idempotency_key_too_long"}}},"exampleType":"examples"}},"exampleType":"examples"},"d25608a2-401c-44b7-a9eb-96570c69b924":{"description":"No token, or an invalid or revoked one.","content":{"application/json":{"schema":{"type":"object","required":["message","code","doc_url"],"properties":{"message":{"type":"string","description":"A sentence for a person, in the installation's language. It may be reworded: test `code`, not the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"description":"What went wrong, in one stable snake_case word. Each one is explained at `doc_url`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"The page of the documentation that explains this code.","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthenticated.","code":"unauthenticated","doc_url":"https://docs.lekalao.com/errors#unauthenticated"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthenticated.","code":"unauthenticated","doc_url":"https://docs.lekalao.com/errors#unauthenticated"}}},"exampleType":"examples"}},"exampleType":"examples"},"38f1223f-ac2a-46b7-8d99-74271b28ae7b":{"description":"Not allowed. `code` says why: `missing_ability` (a read-only token on a write), `role_not_allowed` (the role of the token's owner), `team_suspended`, `team_access_lost` (the owner left the team), `two_factor_required` (the team asks every member for a second factor).","content":{"application/json":{"schema":{"type":"object","required":["message","code","doc_url"],"properties":{"message":{"type":"string","description":"A sentence for a person, in the installation's language. It may be reworded: test `code`, not the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"description":"What went wrong, in one stable snake_case word. Each one is explained at `doc_url`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"The page of the documentation that explains this code.","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"This team is suspended. Contact support.","code":"team_suspended","doc_url":"https://docs.lekalao.com/errors#team_suspended"},"examples":{"Example":{"title":"Example","value":{"message":"This team is suspended. Contact support.","code":"team_suspended","doc_url":"https://docs.lekalao.com/errors#team_suspended"}}},"exampleType":"examples"}},"exampleType":"examples"},"47dfd4f8-3e13-4ec3-b1ef-76ec06e38dd2":{"description":"A call with the same `Idempotency-Key` is still running. Try again a moment later.","content":{"application/json":{"schema":{"type":"object","required":["message","code","doc_url"],"properties":{"message":{"type":"string","description":"A sentence for a person, in the installation's language. It may be reworded: test `code`, not the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"description":"What went wrong, in one stable snake_case word. Each one is explained at `doc_url`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"The page of the documentation that explains this code.","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"A request with this idempotency key is already running.","code":"idempotency_key_in_use","doc_url":"https://docs.lekalao.com/errors#idempotency_key_in_use"},"examples":{"Example":{"title":"Example","value":{"message":"A request with this idempotency key is already running.","code":"idempotency_key_in_use","doc_url":"https://docs.lekalao.com/errors#idempotency_key_in_use"}}},"exampleType":"examples"}},"exampleType":"examples"},"ebfa9d63-99e7-4955-91c2-fce35b9ffbbb":{"description":"Invalid data (`validation_error`), or an `Idempotency-Key` already used for another request (`idempotency_key_reused`) or older than 24 hours (`idempotency_key_expired`).","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"The email field must be a valid email address.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"example":"validation_error","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors","typeLabel":"object"},"problem":{"oneOf":[{"type":"string","enum":["disposable","no_mail_server",null],"description":"Only when the address itself is refused: `disposable` (a throwaway mailbox) or `no_mail_server` (its domain receives no e-mail).","uniqueKey":"problem.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["disposable","no_mail_server",null],"description":"Only when the address itself is refused: `disposable` (a throwaway mailbox) or `no_mail_server` (its domain receives no e-mail).","uniqueKey":"problem.oneOf.1","typeLabel":"null"}],"uniqueKey":"problem","typeLabel":"enum\u003cstring> | null"},"suggestion":{"oneOf":[{"type":"string","format":"email","description":"With `problem`: the address the person very likely meant, when a common domain is one or two keystrokes away. Otherwise `null`.","uniqueKey":"suggestion.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"With `problem`: the address the person very likely meant, when a common domain is one or two keystrokes away. Otherwise `null`.","uniqueKey":"suggestion.oneOf.1","typeLabel":"null"}],"uniqueKey":"suggestion","typeLabel":"string\u003cemail> | null"}},"required":["message","code","doc_url"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The email field must be a valid email address.","code":"validation_error","doc_url":"\u003cstring>","errors":{},"problem":"disposable","suggestion":"jsmith@example.com"}}},"exampleType":"generated"}},"exampleType":"generated"},"5cd5aaca-9d0d-4f29-b7b3-db2632e15c78":{"description":"The token's limit is reached. Wait the number of seconds Retry-After gives.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Calls allowed per minute for this token."},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["message","code","doc_url"],"properties":{"message":{"type":"string","description":"A sentence for a person, in the installation's language. It may be reworded: test `code`, not the message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["address_suppressed","already_in_automation","automation_not_running","bad_request","batch_rejected","campaign_is_sending","campaign_not_ready","confirmation_not_needed","conflict","contact_not_found","content_missing","event_count_out_of_range","forbidden","idempotency_key_expired","idempotency_key_in_use","idempotency_key_reused","idempotency_key_too_long","invalid_request","licence_invalid","licence_revoked","mail_not_kept","method_not_allowed","missing_ability","monthly_quota_exceeded","no_team","not_found","payload_too_large","provider_error","queue_unavailable","rate_limited","recipient_missing","recipients_suppressed","role_not_allowed","sandbox_cannot_send","sender_not_allowed","sending_paused","server_error","service_unavailable","subscriber_limit_reached","team_access_lost","team_suspended","template_error","test_refused","too_many_recipients","two_factor_required","unauthenticated","undeliverable_address","validation_error"],"description":"What went wrong, in one stable snake_case word. Each one is explained at `doc_url`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","format":"uri","description":"The page of the documentation that explains this code.","isRequired":true,"uniqueKey":"doc_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Too many requests. Try again in 12 seconds.","code":"rate_limited","doc_url":"https://docs.lekalao.com/errors#rate_limited"},"examples":{"Example":{"title":"Example","value":{"message":"Too many requests. Try again in 12 seconds.","code":"rate_limited","doc_url":"https://docs.lekalao.com/errors#rate_limited"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"87f09f49-73ef-4e5f-9063-0e3c9d075c26":{"bearer":{"type":"http","scheme":"bearer","description":"An API token. The \"read\" ability: GET routes only. \"read + write\": every route.","scopes":[],"schemeName":"bearer"}}},"servers":{"625bf61b-f921-4af5-aee2-6126e1725dc5":{"url":"https://api.lekalao.com","description":"Lekalao"},"6265c5f9-182f-47e2-b539-473ca46cdc4b":{"url":"https://{host}/api","description":"Your own installation","variables":{"host":{"default":"lekalao.example.com","description":"The domain of your installation"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API token. The \"read\" ability: GET routes only. \"read + write\": every route.","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API token. The \"read\" ability: GET routes only. \"read + write\": every route.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"lekalao","siteName":"Lekalao","title":"Create a campaign - Lekalao","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/campaigns/create-a-campaign","matchLevel":0},"fr":{"href":"/fr","matchLevel":4}}},"lastModified":"2026-11-01T00:09:26.346Z","originalFileLocation":"api-reference/campaigns/create-a-campaign.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The campaign is born a draft, for the whole list, with the list\u0026#x27;s sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Lekalao, e-mail marketing, newsletter, transactional e-mail, e-mail API, campaigns, automations, deliverability\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lekalao\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a campaign - Lekalao\">\u003cmeta data-mint-head property=\"og:description\" content=\"The campaign is born a draft, for the whole list, with the list\u0026#x27;s sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lekalao\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lekalao.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=The+campaign+is+born+a+draft%2C+for+the+whole+list%2C+with+the+list%27s+sender.+To+be+sent%2C+its+content+%28or+its+template%29+must+carry+%60%7B%7B+unsubscribe_url+%7D%7D%60+and+%60%7B%7B+o\u0026amp;theme=ec25875a866709f7372483cb\u0026amp;signature=06d24e712f26e638b2f6747e4d6ca3d38aea6698c6cce432f0b76f6ff7b48970\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a campaign - Lekalao\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The campaign is born a draft, for the whole list, with the list\u0026#x27;s sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lekalao.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=The+campaign+is+born+a+draft%2C+for+the+whole+list%2C+with+the+list%27s+sender.+To+be+sent%2C+its+content+%28or+its+template%29+must+carry+%60%7B%7B+unsubscribe_url+%7D%7D%60+and+%60%7B%7B+o\u0026amp;theme=ec25875a866709f7372483cb\u0026amp;signature=06d24e712f26e638b2f6747e4d6ca3d38aea6698c6cce432f0b76f6ff7b48970\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/lekalao/L7Vx8vzds__oYmHy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lekalao\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006C4D\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_GB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campaigns/create-a-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://lekalao.com/#organization\",\"name\":\"Lekalao\",\"url\":\"https://lekalao.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lekalao/X2dfnmUN5ikXeFCy/logo/light.svg?fit=max\u0026auto=format\u0026n=X2dfnmUN5ikXeFCy\u0026q=85\u0026s=2e6970b4e9a452195680476cf2c13687\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lekalao.com#website\",\"name\":\"Lekalao\",\"url\":\"https://docs.lekalao.com\",\"publisher\":{\"@id\":\"https://lekalao.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign#webpage\",\"url\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign\",\"name\":\"Create a campaign\",\"description\":\"The campaign is born a draft, for the whole list, with the list's sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\",\"dateModified\":\"2026-11-01T00:09:26.346Z\",\"isPartOf\":{\"@id\":\"https://docs.lekalao.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Campaigns\",\"item\":\"https://docs.lekalao.com/api-reference/campaigns/list-the-campaigns\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a campaign\",\"item\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign#apireference\",\"headline\":\"Create a campaign\",\"name\":\"Create a campaign\",\"description\":\"The campaign is born a draft, for the whole list, with the list's sender. To be sent, its content (or its template) must carry {{ unsubscribe_url }} and {{ organisation.address }}, and the postal address must be set in the general settings. The finer settings (segment, sender, UTM, A/B test, spreading, time zone) are made in the interface.\",\"url\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lekalao.com/api-reference/campaigns/create-a-campaign#webpage\"},\"dateModified\":\"2026-11-01T00:09:26.346Z\",\"publisher\":{\"@id\":\"https://lekalao.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lekalao.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lekalao\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lekalao","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"User guide","icon":"book-open","pages":[{"title":"User guide","href":""}]},{"tab":"Developers","icon":"code","pages":[{"title":"Developers","href":"/developers/introduction"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"API reference","icon":"book","href":"/api-reference/introduction"}]},{"group":"Lists","pages":[{"title":"List the e-mail lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists","href":"/api-reference/lists/list-the-e-mail-lists"},{"title":"Create a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists","href":"/api-reference/lists/create-a-list"},{"title":"Read one list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists/{list}","href":"/api-reference/lists/read-one-list"},{"title":"Change a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/lists/{list}","href":"/api-reference/lists/change-a-list"},{"title":"Delete a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/lists/{list}","href":"/api-reference/lists/delete-a-list"}]},{"group":"Subscribers","pages":[{"title":"List the subscribers of a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists/{list}/subscribers","href":"/api-reference/subscribers/list-the-subscribers-of-a-list"},{"title":"Subscribe an address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists/{list}/subscribers","href":"/api-reference/subscribers/subscribe-an-address"},{"title":"Subscribe a batch of addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists/{list}/subscribers/batch","href":"/api-reference/subscribers/subscribe-a-batch-of-addresses"},{"title":"Read one subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/subscribers/{subscriber}","href":"/api-reference/subscribers/read-one-subscriber"},{"title":"Change a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/subscribers/{subscriber}","href":"/api-reference/subscribers/change-a-subscriber"},{"title":"Delete a subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/subscribers/{subscriber}","href":"/api-reference/subscribers/delete-a-subscriber"},{"title":"Unsubscribe someone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/subscribers/{subscriber}/unsubscribe","href":"/api-reference/subscribers/unsubscribe-someone"},{"title":"Subscribe someone again","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/subscribers/{subscriber}/resubscribe","href":"/api-reference/subscribers/subscribe-someone-again"},{"title":"Send the confirmation e-mail again","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/subscribers/{subscriber}/resend-confirmation","href":"/api-reference/subscribers/send-the-confirmation-e-mail-again"},{"title":"Add or remove tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/subscribers/{subscriber}/tags","href":"/api-reference/subscribers/add-or-remove-tags"}]},{"group":"Tags","pages":[{"title":"List the tags of a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists/{list}/tags","href":"/api-reference/tags/list-the-tags-of-a-list"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists/{list}/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tags/{tag}","href":"/api-reference/tags/delete-a-tag"}]},{"group":"Segments","pages":[{"title":"List the segments of a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists/{list}/segments","href":"/api-reference/segments/list-the-segments-of-a-list"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists/{list}/segments","href":"/api-reference/segments/create-a-segment"},{"title":"Read one segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/segments/{segment}","href":"/api-reference/segments/read-one-segment"},{"title":"Change a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/segments/{segment}","href":"/api-reference/segments/change-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/segments/{segment}","href":"/api-reference/segments/delete-a-segment"}]},{"group":"Imports","pages":[{"title":"List the imports of a list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/lists/{list}/imports","href":"/api-reference/imports/list-the-imports-of-a-list"},{"title":"Import a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/lists/{list}/imports","href":"/api-reference/imports/import-a-file"},{"title":"Follow an import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/imports/{import}","href":"/api-reference/imports/follow-an-import"}]},{"group":"Templates","pages":[{"title":"List the templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/templates/list-the-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/templates/create-a-template"},{"title":"Read one template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template}","href":"/api-reference/templates/read-one-template"},{"title":"Change a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/templates/{template}","href":"/api-reference/templates/change-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template}","href":"/api-reference/templates/delete-a-template"}]},{"group":"Campaigns","pages":[{"title":"List the campaigns","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns","href":"/api-reference/campaigns/list-the-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"Read one campaign","description":"While it sends, the figures are worked out as you read them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/campaigns/{campaign}","href":"/api-reference/campaigns/read-one-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/campaigns/{campaign}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"Send now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign}/send","href":"/api-reference/campaigns/send-now"},{"title":"Send a test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/campaigns/{campaign}/test","href":"/api-reference/campaigns/send-a-test"}]},{"group":"Automations","pages":[{"title":"List the automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/automations","href":"/api-reference/automations/list-the-automations"},{"title":"Put someone into an automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/automations/{automation}/trigger","href":"/api-reference/automations/put-someone-into-an-automation"}]},{"group":"Transactional e-mails","pages":[{"title":"Send a transactional e-mail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactional-mails/send","href":"/api-reference/transactional-e-mails/send-a-transactional-e-mail"},{"title":"List transactional e-mails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactional-mails","href":"/api-reference/transactional-e-mails/list-transactional-e-mails"},{"title":"Read one transactional e-mail","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/transactional-mails/{mail}","href":"/api-reference/transactional-e-mails/read-one-transactional-e-mail"},{"title":"Send a transactional e-mail again","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/transactional-mails/{mail}/resend","href":"/api-reference/transactional-e-mails/send-a-transactional-e-mail-again"}]},{"group":"Revenue","pages":[{"title":"Report a sale","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/conversions","href":"/api-reference/revenue/report-a-sale"},{"title":"Remove a sale","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/conversions/{conversion}","href":"/api-reference/revenue/remove-a-sale"}]},{"group":"Contact fields","pages":[{"title":"List the contact fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/fields","href":"/api-reference/contact-fields/list-the-contact-fields"},{"title":"Create a contact field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/fields","href":"/api-reference/contact-fields/create-a-contact-field"},{"title":"Change a contact field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/fields/{field}","href":"/api-reference/contact-fields/change-a-contact-field"},{"title":"Delete a contact field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/fields/{field}","href":"/api-reference/contact-fields/delete-a-contact-field"}]},{"group":"Events","pages":[{"title":"Record an event, or a batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/events","href":"/api-reference/events/record-an-event-or-a-batch"},{"title":"List what one person did","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/events","href":"/api-reference/events/list-what-one-person-did"}]},{"group":"Webhooks","pages":[{"title":"List the outgoing webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-the-outgoing-webhooks"},{"title":"Register an outgoing webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/register-an-outgoing-webhook"},{"title":"Remove an outgoing webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhooks/{webhook}","href":"/api-reference/webhooks/remove-an-outgoing-webhook"},{"title":"See what a call looks like","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhooks/samples/{event}","href":"/api-reference/webhooks/see-what-a-call-looks-like"}]},{"group":"Platform","pages":[{"title":"Whose token is this","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/platform/whose-token-is-this"},{"title":"The installation's OpenAPI document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/openapi.json","href":"/api-reference/platform/the-installations-openapi-document"},{"title":"Check a licence key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/licences/check","href":"/api-reference/platform/check-a-licence-key"}]}]},{"tab":"Self-hosting","icon":"server","hidden":true,"pages":[{"title":"Self-hosting","href":"/self-hosting/overview"}]}]},{"language":"fr","navbar":{"links":[{"href":"/fr/api-reference/introduction","label":"Référence API"}],"primary":{"type":"button","label":"Démarrer","href":"/fr/guide/quickstart"}},"pages":[{"title":"fr","href":"/fr"}]}]},"basePath":"","title":"Create a campaign - Lekalao","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}