MailLandDocs
بازاریابی

اتوماسیون‌ها

تنظیم دنباله‌های ایمیل مبتنی بر رویداد که به‌طور خودکار بر اساس رفتار مشترکین اجرا می‌شوند

اتوماسیون‌ها به شما امکان می‌دهند دنباله‌های ایمیل چند مرحله‌ای ایجاد کنید که توسط رویدادهای مشترک فعال می‌شوند. یک محرک تعریف کنید، دنباله‌ای از مراحل بسازید و MailLand هر بار که محرک فعال می‌شود، جریان را به‌طور خودکار اجرا می‌کند.

محرک‌های اتوماسیون

هر اتوماسیون با یک محرک واحد آغاز می‌شود:

محرکمقدارتوضیحات
SubscriberJoins0مشترک به لیست پستی اضافه می‌شود
SubscriberUpdated1پروفایل مشترک به‌روزرسانی می‌شود
CampaignOpened2مشترک کمپین خاصی را باز می‌کند
CampaignClicked3مشترک روی لینکی در کمپین کلیک می‌کند
DateBased4محرکی فقط برای تاریخ تولد: Subscriber.Birthday را ارزیابی می‌کند (به هشدار زیر مراجعه کنید)

DateBased فقط Subscriber.Birthday را ارزیابی می‌کند، نه هر فیلد تاریخ تکرارشونده‌ی دلخواهی را. Birthday را می‌توان هم از طریق POST/PUT /v1/marketing/subscribers تنظیم کرد (به صفحه‌ی مشترکین مراجعه کنید) و هم از طریق ایمپورت CSV که ستون اختیاری birthday را می‌پذیرد، بنابراین یک اتوماسیون DateBased هر مشترکی را که تاریخ تولدش از هر یک از این دو راه تنظیم شده باشد ثبت‌نام می‌کند.

| Manual | 5 | فعال‌سازی دستی از طریق API |

وضعیت‌های اتوماسیون

وضعیتمقدارتوضیحات
Draft0قابل ویرایش، در حال اجرا نیست
Active1در حال اجرا: مشترکین جدید هنگام فعال‌شدن محرک ثبت‌نام می‌شوند
Paused2متوقف: ثبت‌نام جدیدی انجام نمی‌شود و مراحل بعدی برای مشترکینی که پیش‌تر ثبت‌نام شده‌اند نیز متوقف می‌شود. فعال‌سازی مجدد (Active) هر ثبت‌نام را دقیقاً از همان جایی که متوقف شده ادامه می‌دهد و هر چه در طول توقف سررسید شده باشد را تحویل می‌دهد
Archived3بایگانی‌شده: از نماهای پیش‌فرض پنهان است. مانند Paused، این ثبت‌نام‌های جدید را متوقف می‌کند؛ مراحل بعدی نیز برای مشترکینی که پیش‌تر ثبت‌نام شده‌اند متوقف می‌شود. هیچ endpointـی برای خروج از بایگانی وجود ندارد، بنابراین این توقف برای آن ثبت‌نام‌ها دائمی است

انواع مراحل

هر اتوماسیون شامل یک دنباله مرتب از مراحل است:

نوع مرحلهمقدارتوضیحات
SendEmail0ارسال ایمیل به مشترک
Wait1انتظار برای مدت زمانی قبل از ادامه
Condition2یک فیلد از مشترک را ارزیابی می‌کند؛ دروازه‌ای که در صورت درست‌بودن ادامه می‌یابد و در صورت نادرست‌بودن ثبت‌نام را پایان می‌دهد (به مرحله‌ی Condition در پایین مراجعه کنید)
AddToList3افزودن مشترک به لیست پستی
RemoveFromList4حذف مشترک از لیست پستی
UpdateSubscriber5به‌روزرسانی فیلدهای مشترک
Webhook6ارسال webhook به آدرس URL خارجی

شخصی‌سازی (Personalization)

مراحل ایمیل اتوماسیون از تگ‌های ادغام {{variable}} پشتیبانی می‌کنند که به ازای هر گیرنده از رکورد خودِ مشترک ثبت‌نام‌شده جایگزین می‌شوند.

تگمقدار
{{firstName}}نام مشترک
{{lastName}}نام خانوادگی مشترک
{{fullName}}نام و نام خانوادگی به‌هم پیوسته
{{email}}آدرس ایمیل مشترک
{{subscriberId}}شناسه‌ی مبهم مشترک
{{custom_<field>}}هر فیلد سفارشی روی مشترک: همچنین به‌صورت {{<field>}} هم در دسترس است
مرحله‌ی اتوماسیون شخصی‌سازی‌شده
<p>Hi {{firstName}}, here's what's new this month.</p>

تگی که مقداری ندارد دقیقاً همان‌طور که نوشته شده باقی می‌ماند: {{firstName}} برای مشترکی بدون نام، در ایمیل تحویل‌شده به‌صورت {{firstName}} باقی می‌ماند. محتوایی بنویسید که در هر دو حالت درست خوانده شود. زمانی که مطمئن نیستید همه‌ی مشترکین آن فیلد را دارند، از یک سلام جایگزین استفاده کنید.

مقادیر بر اساس بخشی که در آن قرار می‌گیرند escape می‌شوند: محتوای HTML به‌صورت HTML escape می‌شود، در حالی که خط موضوع و بدنه‌ی متن ساده هرگز escape نمی‌شوند، Ben & Jerry's دقیقاً همان‌گونه باقی می‌ماند.

املای قدیمی‌تر snake_case ({{first_name}}، {{last_name}}، {{full_name}}، {{subscriber_id}}) همچنان به‌عنوان نام‌های مستعار کار می‌کنند.

ایجاد اتوماسیون

POST https://api.mail.land/v1/marketing/automations
درخواست ایجاد اتوماسیون
{
  "name": "Welcome Series",
  "description": "3-email welcome sequence for new subscribers",
  "trigger": 0,
  "mailingListId": "7h3n5k8w2q9m1t",
  "campaignId": null,
  "steps": [
    {
      "type": 0,
      "order": 1,
      "templateId": "2p9x4k7m3q8n1z",
      "subject": "Welcome to our newsletter!"
    },
    {
      "type": 1,
      "order": 2,
      "delayMinutes": 1440
    },
    {
      "type": 0,
      "order": 3,
      "templateId": "9k4p2x7m1q3n8z"
    }
  ]
}
فیلدنوعالزامیتوضیحات
namestringبلهنام اتوماسیون (یکتا در هر فضای کاری)
descriptionstringخیرتوضیحات اتوماسیون
triggerintبلهنوع محرک (جدول محرک‌ها را ببینید)
mailingListIdstringخیرلیست پستی هدف برای محرک
campaignIdstringخیراختیاری برای محرک‌های CampaignOpened / CampaignClicked: در صورت حذف، محرک روی هر کمپینی فعال می‌شود، نه فقط یکی
stepsarrayبلهدنباله مرتب مراحل

فیلد segmentId روی یک اتوماسیون وجود ندارد: این فیلد اینجا وجود ندارد (سگمنت‌ها جای دیگری استفاده می‌شوند، مثلاً در کمپین‌ها). محتوای مرحله‌ی SendEmail از templateId می‌آید، نه از htmlContent/textContent/fromName/fromEmail درون‌خطی.

campaignId برای محرک‌های باز/کلیک اختیاری است، نه الزامی همان‌طور که نسخه‌های قدیمی‌تر این صفحه بیان می‌کردند. همچنین این محرک روی بازشدن‌های ماشینی (پیش‌واکشی Apple Mail Privacy Protection، اسکنرهای امنیتی لینک) هم فعال می‌شود که MailLand امروز آن‌ها را فیلتر نمی‌کند.

فیلدهای مراحل

شکل واقعی هر مرحله { order, type, delayMinutes, templateId, subject, settings: {} } است: هیچ segmentIdای در سطح اتوماسیون وجود ندارد، و مراحل فیلدهای اختصاصی هر نوع که در نسخه‌های قدیمی‌تر این صفحه نشان داده شده بودند را ندارند (conditionField، targetMailingListId، updateField، webhookUrl، fromName، fromEmail، replyTo فیلدهای سطح بالای یک مرحله نیستند). جداول زیر شکل واقعی را نشان می‌دهند.

مرحله SendEmail (type: 0):

فیلدنوعالزامیتوضیحات
typeintبله0
orderintبلهموقعیت مرحله در دنباله
delayMinutesintخیردقیقه‌های انتظار قبل از اجرای این مرحله: حتی وقتی این مرحله اولین مرحله باشد: تأخیر پیش از اولین ارسال اکنون هنگام ثبت‌نام رعایت می‌شود (پیش‌تر نادیده گرفته می‌شد)
templateIdstringبلهقالبی که محتوای ایمیل را تأمین می‌کند، محتوا فقط از قالب می‌آید
subjectstringخیردر صورت تنظیم، موضوع قالب را بازنویسی می‌کند

هیچ htmlContent/textContent/fromName/fromEmail/replyTo درون‌خطی روی یک مرحله وجود ندارد. فرستنده به‌صورت ثابت noreply@<اولین دامنه‌ی کاملاً تأییدشده> است که همراه با نام فضای کاری نمایش داده می‌شود: به ازای هر مرحله قابل تنظیم نیست.

templateId در هر مرحله‌ی SendEmail الزامی است. درخواست‌های ایجاد/به‌روزرسانی بدون آن با 400 VALIDATION_FAILED رد می‌شوند؛ templateIdای که به هیچ قالبی در مستأجر شما اشاره نکند با 400 TEMPLATE_NOT_FOUND رد می‌شود: هر دو پیش از نوشته‌شدن هرچیزی. اگر قالبی پس از ذخیره‌شدن اتوماسیون حذف شود، ثبت‌نامِ اولین مشترکی که به آن مرحله می‌رسد به‌جای رد شدن بی‌صدا، Failed علامت‌گذاری می‌شود و در totalFailed اتوماسیون شمرده می‌شود (به دریافت جزئیات اتوماسیون مراجعه کنید).

مرحله Wait (type: 1):

فیلدنوعالزامیتوضیحات
typeintبله1
orderintبلهموقعیت مرحله
delayMinutesintبلهدقیقه‌های انتظار قبل از مرحله بعدی

مرحله Condition (type: 2):

یک مرحله‌ی Condition یک دروازه است، نه یک انشعاب: فهرست خطی مراحل مسیر دومی ندارد. وقتی ارزیابی درست باشد، ثبت‌نام به مرحله‌ی بعدی ادامه می‌یابد. وقتی ارزیابی نادرست باشد، ثبت‌نام همان‌جا (Completed) پایان می‌یابد و هیچ مرحله‌ی بعدی برای آن مشترک اجرا نمی‌شود.

فیلدنوعالزامیتوضیحات
typeintبله2
orderintبلهموقعیت مرحله
settings.conditionFieldstringبلهفیلدی از مشترک که باید ارزیابی شود: email، firstName، lastName، phone، company، source، یا custom_<name> برای یک فیلد سفارشی
settings.conditionOperatorstringبلهequals، notEquals، contains، notContains، startsWith، endsWith، isEmpty، isNotEmpty (بدون حساسیت به بزرگی/کوچکی حروف)
settings.conditionValuestringالزامی مگر با isEmpty/isNotEmptyمقداری که باید مقایسه شود

مقایسه‌ها مقایسه‌ی رشته‌ای بدون حساسیت به بزرگی/کوچکی حروف هستند، همان عملگرهایی که سگمنت‌ها هم‌اکنون ارائه می‌دهند. 400 VALIDATION_FAILED هنگام ایجاد/به‌روزرسانی زمانی بازگردانده می‌شود که conditionField ناشناخته باشد، conditionOperator یکی از مقادیر بالا نباشد، یا conditionValue برای عملگری که به آن نیاز دارد وجود نداشته باشد.

مرحله‌ی Conditionای که پیش از وجود این اعتبارسنجی ذخیره شده (و بنابراین تنظیماتش قابل‌ارزیابی نیست) برای حفظ پیوستگی بدون تغییر عبور می‌کند: فقط درخواست‌های جدید ایجاد/به‌روزرسانی اعتبارسنجی می‌شوند.

مراحل AddToList / RemoveFromList (type: 3, 4):

فیلدنوعالزامیتوضیحات
typeintبله3 یا 4
orderintبلهموقعیت مرحله
settings.mailingListIdstringبلهلیست پستی برای افزودن/حذف مشترک، خوانده‌شده از settings

مرحله UpdateSubscriber (type: 5):

فیلدنوعالزامیتوضیحات
typeintبله5
orderintبلهموقعیت مرحله
settingsobjectبلههر کلید در settings به‌عنوان یک فیلد سفارشی روی مشترک نوشته می‌شود

مرحله Webhook (type: 6):

فیلدنوعالزامیتوضیحات
typeintبله6
orderintبلهموقعیت مرحله
settings.urlstringبلهآدرس URL برای ارسال درخواست POST، خوانده‌شده از settings

درخواست‌های گام Webhook با کلید گیرندهٔ همان گام امضا می‌شوند (X-MLND-Signature که مثل وب‌هوک مشتری بررسی می‌شود): هر نشانی URL جداگانهٔ گام کلید خودش را دارد، پس هیچ گیرنده‌ای نمی‌تواند به‌جای گیرندهٔ دیگر امضا کند. کلیدها را با GET /v1/marketing/automations/{id}/webhook-signing-secrets بخوانید و با POST /v1/marketing/automations/{id}/webhook-signing-secrets/regenerate عوض کنید، نسخه‌بندی را ببینید. برای عوض‌کردن کلید فقط یک گیرنده، { "webhookUrl": "…" } را بفرستید.

Create an automation
curl -X POST https://api.mail.land/v1/marketing/automations \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome Series",
    "trigger": 0,
    "mailingListId": "7h3n5k8w2q9m1t",
    "steps": [
      {
        "type": 0, "order": 1,
        "subject": "Welcome!",
        "templateId": "2p9x4k7m3q8n1z"
      },
      { "type": 1, "order": 2, "delayMinutes": 1440 },
      {
        "type": 0, "order": 3,
        "subject": "Getting started",
        "templateId": "9k4p2x7m1q3n8z"
      }
    ]
  }'

پاسخ

پاسخ اتوماسیون
{
  "id": "4f8k2m9p1q6z3s",
  "name": "Welcome Series",
  "description": "3-email welcome sequence for new subscribers",
  "trigger": "subscriberJoins",
  "triggerName": "SubscriberJoins",
  "status": "draft",
  "statusName": "Draft",
  "mailingListId": "7h3n5k8w2q9m1t",
  "mailingListName": "Product Updates",
  "campaignId": null,
  "campaignName": null,
  "stepsCount": 3,
  "totalEnrolled": 0,
  "totalCompleted": 0,
  "activatedAt": null,
  "createdAt": "2026-02-17T12:00:00Z",
  "updatedAt": "2026-02-17T12:00:00Z"
}

هیچ فیلد segmentId/segmentNameای روی یک اتوماسیون وجود ندارد، و شمارنده‌های ثبت‌نام totalEnrolled/totalCompleted هستند (نه totalEnrollments/activeEnrollments/completedEnrollments). پاسخ جزئیات همچنین steps (فهرست کامل مراحل)، completionRate و totalFailed را اضافه می‌کند: ثبت‌نام‌هایی که به مرحله‌ی SendEmailای بدون قالب در مستأجر رسیده‌اند (مفقود یا بعداً حذف‌شده).

فهرست اتوماسیون‌ها

GET https://api.mail.land/v1/marketing/automations
پارامترنوعپیش‌فرضتوضیحات
cursorstring-نشانگر مبهم از nextCursor صفحهٔ قبل. برای صفحهٔ اول حذف کنید.
limitint20تعداد آیتم در هر صفحه
searchstring-جستجو بر اساس نام
statusint-فیلتر بر اساس وضعیت اتوماسیون
triggerint-فیلتر بر اساس نوع محرک
mailingListIdstring-فیلتر بر اساس لیست پستی
sortBystring-فیلد مرتب‌سازی
sortDescboolfalseمرتب‌سازی نزولی
List automations
curl https://api.mail.land/v1/marketing/automations \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

دریافت جزئیات اتوماسیون

GET https://api.mail.land/v1/marketing/automations/{id}

اتوماسیون کامل شامل تمام مراحل را برمی‌گرداند:

Get automation details
curl https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."
پاسخ جزئیات اتوماسیون
{
  "id": "4f8k2m9p1q6z3s",
  "name": "Welcome Series",
  "description": "3-email welcome sequence for new subscribers",
  "trigger": "subscriberJoins",
  "triggerName": "SubscriberJoins",
  "status": "active",
  "statusName": "Active",
  "mailingListId": "7h3n5k8w2q9m1t",
  "mailingListName": "Product Updates",
  "campaignId": null,
  "campaignName": null,
  "stepsCount": 3,
  "totalEnrolled": 230,
  "totalCompleted": 200,
  "totalFailed": 4,
  "activatedAt": "2026-01-10T08:05:00Z",
  "steps": [
    {
      "order": 1,
      "type": "sendEmail",
      "typeName": "SendEmail",
      "delayMinutes": null,
      "templateId": "2p9x4k7m3q8n1z",
      "subject": "Welcome to our newsletter!",
      "settings": null
    },
    {
      "order": 2,
      "type": "wait",
      "typeName": "Wait",
      "delayMinutes": 1440,
      "templateId": null,
      "subject": null,
      "settings": null
    },
    {
      "order": 3,
      "type": "sendEmail",
      "typeName": "SendEmail",
      "delayMinutes": null,
      "templateId": "9k4p2x7m1q3n8z",
      "subject": "Getting started with MailLand",
      "settings": null
    }
  ],
  "completionRate": 86.96,
  "createdAt": "2026-01-10T08:00:00Z",
  "updatedAt": "2026-02-17T12:00:00Z"
}

به‌روزرسانی اتوماسیون

PUT https://api.mail.land/v1/marketing/automations/{id}

هر وضعیتی به‌جز Active قابل به‌روزرسانی است (نه فقط Draft/Paused). بدنه درخواست مشابه درخواست ایجاد است.

Update an automation
curl -X PUT https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Welcome Series",
    "trigger": 0,
    "mailingListId": "7h3n5k8w2q9m1t",
    "steps": [
      {
        "type": 0, "order": 1,
        "subject": "Welcome!",
        "templateId": "2p9x4k7m3q8n1z"
      },
      { "type": 1, "order": 2, "delayMinutes": 1440 },
      {
        "type": 0, "order": 3,
        "subject": "Getting started",
        "templateId": "9k4p2x7m1q3n8z"
      }
    ]
  }'

فعال‌سازی اتوماسیون

POST https://api.mail.land/v1/marketing/automations/{id}/activate

اتوماسیون را از وضعیت Draft یا Paused به Active منتقل می‌کند. پس از فعال‌سازی، اتوماسیون شروع به ثبت‌نام مشترکین هنگام فعال‌شدن محرک می‌کند.

خودِ فعال‌سازی در برابر تأیید دامنه بررسی نمی‌شود. مرحله‌ی SendEmailای که بدون هیچ دامنه‌ی کاملاً تأییدشده‌ای به آن رسیده شود، نگه‌داشته می‌شود، نه نادیده گرفته می‌شود: با فاصله‌ی زمانی رو به رشد (۱۵ دقیقه، سپس تا هر ۶ ساعت) دوباره بررسی می‌شود و به‌محض تأیید یک دامنه ارسال می‌شود. اگر ظرف ۷ روز از زمانی که آن مرحله برای اولین‌بار سررسید شده، هیچ دامنه‌ای تأیید نشود، ثبت‌نام به‌جای نگه‌داشته‌شدنِ بی‌پایان، Failed علامت‌گذاری می‌شود (در totalFailed شمرده می‌شود): پس فعال‌سازی بدون هیچ دامنه‌ی تأییدشده‌ای موفق است، اما تا زمانی که یک دامنه را تأیید نکنید چیزی تحویل داده نمی‌شود، و ثبت‌نام‌هایی که پس از یک هفته هنوز منتظرند، به‌جای نگه‌داشتنِ نامحدود، پایان می‌یابند.

Activate an automation
curl -X POST https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s/activate \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

توقف اتوماسیون

POST https://api.mail.land/v1/marketing/automations/{id}/pause

اتوماسیون را متوقف می‌کند. هیچ مشترک جدیدی ثبت‌نام نمی‌شود، و مشترکینی که در حال حاضر در دنباله هستند دیگر پیش نمی‌روند: هر ثبت‌نام در مرحله‌ی فعلی خود متوقف می‌شود. فعال‌سازی دوباره‌ی اتوماسیون هر ثبت‌نام متوقف‌شده را از همان‌جایی که بود ادامه می‌دهد و هر چه در طول توقف سررسید شده باشد را تحویل می‌دهد.

Pause an automation
curl -X POST https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s/pause \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

بایگانی اتوماسیون

POST https://api.mail.land/v1/marketing/automations/{id}/archive

اتوماسیون را بایگانی می‌کند، کاری که از هر وضعیتی از جمله Active قابل انجام است. اتوماسیون‌های بایگانی‌شده از نماهای پیش‌فرض فهرست پنهان هستند.

بایگانی هم ثبت‌نام‌های جدید و هم مراحل بعدی برای مشترکینی که از قبل ثبت‌نام شده‌اند را متوقف می‌کند: هر ثبت‌نام در مرحله‌ی فعلی خود متوقف می‌شود، درست مانند توقف موقت. برخلاف توقف موقت، هیچ endpointـی برای فعال‌سازی دوباره‌ی اتوماسیون Archived وجود ندارد، بنابراین این توقف خودبه‌خود برطرف نمی‌شود.

Archive an automation
curl -X POST https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s/archive \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

کپی اتوماسیون

POST https://api.mail.land/v1/marketing/automations/{id}/duplicate?name=Copy%20of%20Welcome%20Series

یک اتوماسیون جدید با وضعیت Draft و مراحل و تنظیمات کلون‌شده ایجاد می‌کند. پارامتر name اختیاری است.

Duplicate an automation
curl -X POST "https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s/duplicate?name=Copy%20of%20Welcome%20Series" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

فعال‌سازی دستی

POST https://api.mail.land/v1/marketing/automations/{id}/trigger
درخواست فعال‌سازی دستی
{
  "subscriberIds": ["3m8k1p9x4q7n2z", "6q2n9k4x1p8m3z", "1x7m3q8k2n9p4z"]
}

مشترکین مشخص را به‌صورت دستی در اتوماسیون ثبت‌نام می‌کند. اتوماسیون باید در وضعیت Active باشد و نوع محرک آن باید Manual (5) باشد.

Trigger automation manually
curl -X POST https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s/trigger \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{"subscriberIds": ["3m8k1p9x4q7n2z", "6q2n9k4x1p8m3z", "1x7m3q8k2n9p4z"]}'

ردیابی ثبت‌نام

پیشرفت هر مشترک در اتوماسیون به عنوان یک ثبت‌نام ردیابی می‌شود:

وضعیتمقدارتوضیحات
Active0در حال عبور از مراحل
Paused1ثبت‌نام متوقف شده
Completed2تمام مراحل به پایان رسیده
Failed3مرحله‌ی SendEmailای که در این مستأجر قالبی ندارد: از ابتدا مفقود یا بعداً حذف‌شده. در totalFailed اتوماسیون شمرده می‌شود
Unsubscribed4مشترک در طول دنباله لغو اشتراک کرده

هیچ وضعیت ثبت‌نام Cancelledای وجود ندارد. پاسخ جزئیات اتوماسیون شامل شمارش تجمیعی ثبت‌نام‌ها به‌صورت totalEnrolled و totalCompleted است (نه totalEnrollments/activeEnrollments/completedEnrollments/failedEnrollments).

حذف اتوماسیون

DELETE https://api.mail.land/v1/marketing/automations/{id}

اتوماسیون، مراحل و داده‌های ثبت‌نام آن را به‌طور دائمی حذف می‌کند.

به‌روزرسانی و حذف برای هر وضعیتی به‌جز Active مجاز است: نه فقط Draft/Paused (به‌روزرسانی) یا Draft/Archived (حذف) همان‌طور که نسخه‌های قدیمی‌تر این صفحه بیان می‌کردند.

Delete an automation
curl -X DELETE https://api.mail.land/v1/marketing/automations/4f8k2m9p1q6z3s \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

پاسخ‌های خطا

وضعیتکدتوضیحات
400VALIDATION_FAILEDفیلدهای الزامی وارد نشده یا تنظیمات مرحله نامعتبر: از جمله مرحله‌ی SendEmailای بدون templateId یا مرحله‌ی Conditionای با settings غیرقابل‌ارزیابی
400TEMPLATE_NOT_FOUNDtemplateId یک مرحله‌ی SendEmail به هیچ قالبی در مستأجر شما اشاره نمی‌کند
400INVALID_REQUESTنام اتوماسیون قبلاً وجود دارد یا انتقال وضعیت نامعتبر
403FORBIDDENسطح دسترسی ناکافی
404RESOURCE_NOT_FOUNDاتوماسیون یافت نشد، یا انتقال وضعیت نامعتبر است (به‌روزرسانی/فعال‌سازی/توقف با وضعیت نادرست، حذف یک اتوماسیون Active)

اندپوینت‌های اتوماسیون هرگز پاسخ 422 برنمی‌گردانند.

مراحل بعدی

  • کمپین‌ها: ارسال کمپین‌های یک‌بار مصرف
  • مشترکین: مدیریت مخاطبینی که اتوماسیون‌ها هدف قرار می‌دهند
  • لیست‌ها: سازماندهی مشترکین در لیست‌ها برای محرک‌ها

در این صفحه