Zinn® Campaigns API او MCP: د پرمخ بیوونکي لارښود

هر هغه څه چې تاسو یې په ډېشبورډ کې په Zinn® Campaigns کې کولی شئ، د API له لارې هم ترسره کولی شئ، او ډېری یې د MCP له لارې ستاسو له حساب سره نښلول شوي AI مرستیال څخه هم ترسره کېدای شي. دا لارښود ننوتل، اجازې، په دواړو لارو یو عملي مثال، محدودیتونه، تېروتنې او د Campaigns ټول ۸۹ عملیات تر پوښښ لاندې راولي. لاندې د عملیاتو لست زموږ د API له مشخصاتو څخه تولید شوی، نو دا تل د هغه څه سره سمون لري چې API یې ترسره کوي. د هر عملیات هره برخه په zinndigital.com/developers/api/zinn-campaigns کې د API په مرجع کې شتون لري.

ننوتل

• د API کیليګانې. په ډشبورډ کې د ترتیبات → د API کیليګانې لاندې یوه کیلي جوړه کړئ او د Authorization: Bearer zdk_live_… په بڼه یې واستوئ (یو zdk_test_… کیلي په سینډباکس حالت کې کار کوي). کیلي ته یوازې اړین د Campaigns واکونه ورکړئ او نور هېڅ نه.
• د AI مرستیالان (MCP). Claude، ChatGPT، Cursor یا هر MCP پیرودونکی له https://api.zinndigital.com/v1/mcp سره وصل کړئ، یا له اپلیکیشن څخه د ننوتلو له لارې او یا د پیوستون د ټوکن (zmcp_live_…) سره. ستاسو له حساب سره د Claude، Cursor یا ChatGPT نښلول وګورئ. د رضایت په سکرین کې، د Zinn® Campaigns واکونه نښه کړئ.
• واکونه. email_marketing.view کمپاینونه، لستونه، اړيکې، فورمې، لیږونکي، د SMS ترتیبات او راپورونه لولي؛ email_marketing.manage یې جوړوي او بدلون پکې راولي. هغه کمپاینونه چې تاسو یې د خپل برېښنالیک خدمت له لارې استوئ، campaigns.view او campaigns.manage کاروي.
• بیا پلورونکي. د خپلو پیرودونکو سازمانونو څخه په یوه باندې د اجراآتو لپاره org_id واستوئ. که ستاسو کیلي یا پیوستون یوازې یو سازمان پوښي، دا پریږدئ.

بېلګه: د API په مرسته د کمپاین یوه مسوده جوړول

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

ځواب د مسودې سره 201 دی. دا په POST /v1/email-marketing/campaigns/{campaign_id}/test وازموئ، په GET /v1/email-marketing/campaigns/{campaign_id}/lint یې وګورئ، او په POST /v1/email-marketing/campaigns/{campaign_id}/send یې واستوئ.

بېلګه: د AI مرستیال لخوا ورته مسوده

له خپل مرستیال څخه په ساده کلمو وپوښتئ، د بېلګې په توګه "د Spring sale په نوم د Zinn® Campaigns یو برېښنالیک مسوده کړئ چې موضوع یې 'Our spring sale starts today' وي". د پردې تر شا دا کړنه د api_operations_search په واسطه لټوي، پارامترونه یې د api_operation_get په واسطه لولي، او د api_operation_call په واسطه یې پرمخ وړي:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

هغه څه چې یو مرستیال یې نه کوي. هر هغه څه چې ستاسو ترلاسه کوونکو ته استول کېږي یا پیسې یا لګښت لګوي — لکه د کمپاین استول، د SMS یا WhatsApp پیغامونو استول، د AI کریډیټونو په مرسته لیکل، د US د پیغام استولو لپاره نوم لیکنه — د یو مرستیال لپاره منع دي، ترڅو یو ناسم پوهېدل شوی لارښود هېڅکله ستاسو پېرودونکو ته ونه رسېږي. مرستیال مسوده چمتو کوي؛ تاسو په ډشبورډ کې استول کېکاږئ یا خپله API ته زنګ ووهئ. رازونه لکه د SMTP پټنوم هم هېڅکله د یو مرستیال له لارې نه تېرېږي: هغه په ډشبورډ کې دننه کړئ.

محدودیتونه

• د هر کس یا API کیلي لپاره په یوه دقیقه کې ۱،۲۰۰ غوښتنې، او د هر سازمان لپاره په یوه دقیقه کې ۶،۰۰۰ غوښتنې. له دواړو څخه ډېر سخت یې پلي کېږي.
• د هر MCP اړیکې لپاره په یوه دقیقه کې ۶۰۰ غوښتنې.
• له یو محدودیت څخه په اوښتلو سره، ځواب د Retry-After سرلیک سره 429 دی: هغومره ثانیې انتظار وکړئ.
• د لست د غړو اضافه کول په هره غوښتنه کې تر ټولو زیات ۱،۰۰۰ ادرسونه اخلي؛ ستاسو د پلان د اړیکو او برېښنالیکونو اجازه په هر هغه څه پلي کېږي چې تاسو یې د API له لارې ترسره کوئ.

تېروتنې

هره تېروتنه یو شان بڼه لري:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

د ورته ستونزې لپاره code هېڅکله نه بدلېږي، نو د message پر ځای هغه وازمویئ. کله چې تاسو د ملاتړ سره اړیکه ونیسئ، request_id وښایاست. هغه ځوابونه چې تاسو به ورسره مخ شئ: 401 UNAUTHORIZED، 403 FORBIDDEN، 404 NOT_FOUND، 409 CONFLICT، 422 UNPROCESSABLE_ENTITY، 429 TOO_MANY_REQUESTS. یو 403 پدې معنی دی چې کیلي یا اتصال هغه اجازه نلري چې لاندې لیست یې نوموي؛ یو 404 په یو سازمان کې هغه څه هم پوښي چې تاسو یې نشئ لیدلی؛ یو 422 په details کې هر ناسم ډګر لیست کوي؛ د 429 وروسته، د Retry-After په سرلیک کې د ثانیو شمیر انتظار وکړئ.

ویب‌هوکس

د تحویل پایلې له هغه چمتو کونکي څخه Zinn® Campaigns ته راځي چې ستاسو بریښنالیک لیږي:

• د خپل چمتو کونکي سره (د مثال په توګه Resend)، د هغې د ویب‌هوکس لاسلیک راز په ډشبورډ کې د لیږلو په اتصال کې خوندي کړئ (کمپاینونه ← لیږل). تاسو یو webhook_url ترلاسه کوئ؛ د چمتو کونکي delivered، bounced او complained پیښې ورته وټاکئ. یو باؤنس یا د سپیم شکایت سمدلاسه پته د راتلونکي لیږلو څخه لرې کوي.
• د Zinn® لیږلو سره، د تنظیم کولو لپاره هیڅ نشته.

پایلې د راپور عملیاتو سره ولولئ (getEmailMarketingCampaignReport، getSmsMarketingCampaignReport).

د Campaigns هر عملیات

عمومي کتنه

• GET /v1/email-marketing — د یوه سازمان لپاره د Zinn® Campaigns عمومي کتنه. عملیات getEmailMarketingOverview. چک شوې اجازې: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.

د بریښنالیک کمپاینونه

• GET /v1/email-marketing/campaigns — د بریښنالیک کمپاینونه، نوي لومړی، د کیسیټ یوه پاڼه. عملیه listEmailMarketingCampaigns. چک شوي واکونه: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/campaigns — د بریښنالیک کمپاین مسوده جوړه کړئ. عملیه createEmailMarketingCampaign. چک شوي واکونه: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/email-marketing/campaigns/{campaign_id} — د بریښنالیک یو کمپاین. عملیه getEmailMarketingCampaign. چک شوي واکونه: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — یوه مسوده سمون کړئ (یا یو رد شوی کمپاین، چې بیرته مسودې ته ګرځي). عملیه updateEmailMarketingCampaign. چک شوي واکونه: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — د لیږلو دمخه د کمپاین متن د رسولو د ستونزو لپاره وګورئ. عملیه lintEmailMarketingCampaign. چک شوي واکونه: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — د کمپاین شمېرې. عملیه getEmailMarketingCampaignReport. چک شوي واکونه: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — خپل لېست ته د کمپاین لېږل پیل کړئ. عملیه sendEmailMarketingCampaign. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: یوازې API او ډشبورډ: دا پیسې یا کوټه مصرفوي، نو یو شخص یې فشاروي (اصلي ترلاسه کونکو ته یې لېږي او کوټه مصرفوي).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — د سازمان یو غړي ته همدا اوس یوه ازمایښتي کاپي ولېږئ. عملیه testEmailMarketingCampaign. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — کمپاین د اړیکې هرې هغې ژبې ته وژباړئ چې ورکه یا زړه شوې وي. عملیه translateEmailMarketingCampaign. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — د یو کمپاین د لېست د اړیکې هره ژبه او دا چې آیا د هغې ژباړه نوې ده که نه. عملیه listEmailMarketingCampaignTranslations. چک شوي اجازې: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.

د AI سره لیکل

• POST /v1/email-marketing/ai/write — د Zinn® AI سره د یوې لنډې طرحې څخه د کمپاین مسوده بریښنالیک ولیکئ. عملیه writeEmailMarketingCampaignWithAi. چک شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: یوازې API او ډشبورډ: دا پیسې یا تخصیص مصرفوي، نو یو شخص یې فشاروي (د AI لیکل د AI کریډیټ مصرفوي).

د برانډ کټ

• GET /v1/email-marketing/brand-kit — د سازمان د برانډ کټ (نوم، لوګو، رنګونه، فونټ، غږ). عملیه getEmailMarketingBrandKit. چک شوي اجازې: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• PUT /v1/email-marketing/brand-kit — د برانډ کټ سمون کړئ. عملیه updateEmailMarketingBrandKit. چک شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/brand-kit/read — د سازمان له ویب پاڼې څخه د برانډ کټ ولولئ. عملیه readEmailMarketingBrandKit. چک شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.

اړیکې او یو ځل پیغامونه

• GET /v1/email-marketing/contacts — د سازمان اړیکې، په یو وخت کې د کیسیټ یوه پاڼه. عملیه listEmailMarketingContacts. کتل شوي واکونه: email_marketing.view. د AI له مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/contacts/{contact_id}/messages — یوې اړیکې ته یو SMS واستوئ، چې پیسې یې د Zinn® د کریډیټ له بیلانس څخه ورکول کېږي. عملیه sendEmailMarketingMessage. کتل شوي واکونه: email_marketing.manage، email_marketing.view. د AI له مرستیال څخه: یوازې API او ډشبورډ: دا پیسې یا کریډیټ لګوي، نو یو شخص یې فشاروي (یوې اړیکې ته یو ځل پیغام استول کریډیټ لګوي).
• GET /v1/email-marketing/messages — د سازمان لخوا لیږل شوي SMS او WhatsApp پیغامونه، لومړی نوي، د کیسیټ یوه پاڼه. عملیه listEmailMarketingMessages. کتل شوي واکونه: email_marketing.view. د AI له مرستیال څخه: هو، د MCP له لارې.

لړۍ

• GET /v1/email-marketing/lists — د سازمان د برېښنالیک لېستونه د ګډونوالو / وتلو شوو شمېر سره. عملیه listEmailMarketingLists. تایید شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/lists — یو د برېښنالیک لېست جوړ کړئ (یا هغه لېست چې دا نوم لري بېرته ترلاسه کړئ). عملیه createEmailMarketingList. تایید شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/lists/{list_id}/members — د برېښنالیک آدرس له لارې لېست ته اړیکې اضافه کړئ (په هر غوښتنه کې تر ټولو ډېر ۱,۰۰۰). عملیه addEmailMarketingListMembers. تایید شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.

واردول

• GET /v1/email-marketing/imports — د اړیکو پخواني واردول، نوي لومړی، په یو وخت کې د keyset یوه پاڼه. عملیه listEmailMarketingImports. تایید شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/imports — د اړیکو یوه برخه د هغې د رضایت تصدیق سره وارد کړئ. عملیه createEmailMarketingImport. تایید شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.

د نوم لیکنې فورمې

• GET /v1/email-marketing/forms — د نوم لیکنې فورمې (دوه ګونی تایید)، نوي لومړی، د کیسیټ یوه پاڼه. عملیه listEmailMarketingForms. کتل شوي اجازې: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/forms — د نوم لیکنې داسې فورمه جوړه کړئ چې تایید شوي کسان یو لست ته ورزیات کړي. عملیه createEmailMarketingForm. کتل شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• DELETE /v1/email-marketing/forms/{form_id} — د نوم لیکنې فورمه ړنګه کړئ (هغه کسان چې لا دمخه تایید شوي په لست کې پاتې کیږي). عملیه deleteEmailMarketingForm. کتل شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• PATCH /v1/email-marketing/forms/{form_id} — د نوم لیکنې فورمه بدله کړئ (متن، لست، بیا لارښود، فعال یا غیر فعال). عملیه updateEmailMarketingForm. کتل شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.

د لېږلو نښلونې

• GET /v1/email-marketing/senders — د سازمان د لېږلو نښلونونه. عملیه listEmailMarketingSenders. کتل شوي اجازې: email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/senders — د کمپاین لېږونکی ونښلوئ (د Zinn® لېږل، یا د پېرودونکي خپل SMTP سرور). عملیه createEmailMarketingSender. کتل شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: یوازې API او ډشبورډ: دا یو راز لېږدوي چې باید هېڅکله د AI ماډل ته ونه رسیږي (د باډي منځپانګه د SMTP پټنوم دی).
• DELETE /v1/email-marketing/senders/{sender_id} — د لېږلو نښلون او د هغه زېرمه شوی پټنوم لرې کړئ. عملیه deleteEmailMarketingSender. کتل شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/senders/{sender_id}/verify — له هېڅ شی لېږلو پرته ثابت کړئ چې د لېږلو یو نښلون کار کوي. عملیه verifyEmailMarketingSender. کتل شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: هو، د MCP له لارې.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — د دې نښلون لپاره د خپل برېښنالیک وړاندې کوونکي د ویب‌هووک لاسلیک راز زېرمه کړئ. عملیه setEmailMarketingSenderWebhook. کتل شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال څخه: د بل سیسټم (وړاندې کوونکي یا لیدونکي) لخوا غوښتل کیږي، نه ستاسو لخوا (د یو وړاندې کوونکي د ویب‌هووک راز زېرمه کوي).

SMS او WhatsApp

• GET /v1/email-marketing/sms — هغه څه چې د SMS سکرین ورته اړتیا لري — خلاص دی؟، ځنډول شوی دی؟، د کرېډېټ بیلانس او نرخونه. عملیه getEmailMarketingSms. چک شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• GET /v1/email-marketing/sms/campaigns — ټولیز کمپاینونه د SMS، تر ټولو نوي لومړی، د keyset یوه پاڼه. عملیه listSmsMarketingCampaigns. چک شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/sms/campaigns — یوه لېست ته مسوده SMS جوړ کړئ. عملیه createSmsMarketingCampaign. چک شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — یو ټولیز SMS کمپاین. عملیه getSmsMarketingCampaign. چک شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — مسوده ایډیټ کړئ (یا رد شوی کمپاین، چې بیرته مسودې ته راګرځي). عملیه updateSmsMarketingCampaign. چک شوي اجازې: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — د یوه ټولیز SMS کمپاین شمېرې. عملیه getSmsMarketingCampaignReport. چک شوي اجازې: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — د دې په لیست کې هر هغه چا ته د SMS استول پیل کړئ چې د SMS ترلاسه کولو سره یې موافقه کړې وي — یا هغه یو بیا پیل کړئ چې د کریډیټ له امله ځنډول شوی وي. عملیه sendSmsMarketingCampaign ده. چک شوي واکونه: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: یوازې API او ډشبورډ: دا پیسې یا تخصیص مصرفوي، نو یو شخص یې باید کېکاږي (پیسې لرونکي SMS/WhatsApp پیغامونه استوي).
• GET /v1/email-marketing/sms/registrations/us — د دې سازمان US 10DLC راجستر کول، او د هغه لګښت څومره دی. عملیه getEmailMarketingUsRegistration ده. چک شوي واکونه: email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/sms/registrations/us — د US 10DLC لپاره د دې سازمان نښه او کمپاین وسپارئ (په سپارلو لګښت اخیستل کېږي). عملیه submitEmailMarketingUsRegistration ده. چک شوي واکونه: email_marketing.manage، email_marketing.view. د AI مرستیال لخوا: یوازې API او ډشبورډ: دا پیسې یا تخصیص مصرفوي، نو یو شخص یې باید کېکاږي (د US 10DLC راجستر کول د شبکې فیسونه لري).

ستاسو د خپل بریښنالیک خدمت له لارې کمپاینونه (کينډۍ، برخې، مخنیوي)

• GET /v1/campaigns — د سازمان کمپاینونه. عملیه listCampaigns ده. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/campaigns — له یوې کينډۍ او لیدونکو څخه کمپاین جوړ کړئ. عملیه createCampaign ده. د AI مرستیال لخوا: هو، د MCP له لارې.
• DELETE /v1/campaigns/esp — د برابروونکي حساب پرې کړئ او د هغه زېرمه شوې کیلي لرې کړئ. عملیه disconnectEsp. د AI له یوه مرستیال څخه: یوازې API او ډشبورډ: دا یو پټ راز لېږدوي چې باید هېڅکله د AI تر یوه موډل ونه رسېږي (زېرمه شوې ESP کیلي له منځه وړي).
• GET /v1/campaigns/esp — پخپله د سازمان د برېښنالیک برابروونکي حساب. عملیه getEspConnection. د AI له یوه مرستیال څخه: هو، د MCP له لارې.
• POST /v1/campaigns/esp — د برېښنالیک یو برابروونکی حساب وتړئ. عملیه connectEsp. د AI له یوه مرستیال څخه: یوازې API او ډشبورډ: دا یو پټ راز لېږدوي چې باید هېڅکله د AI تر یوه موډل ونه رسېږي (جسم یې د ESP API کیلي ده).
• POST /v1/campaigns/esp/verify — ثابته کړئ چې د برابروونکي حساب کار کوي او د هغه تایید شوې ډومینونه ولولئ. عملیه verifyEspConnection. د AI له یوه مرستیال څخه: یوازې API او ډشبورډ: دا یو پټ راز لېږدوي چې باید هېڅکله د AI تر یوه موډل ونه رسېږي (زېرمه شوې ESP کیلي بیا ګوري).
• POST /v1/campaigns/preview — یوه کينډۍ د بېلګې له ارزښتونو سره Render کړئ. عملیه previewCampaignTemplate. د AI له یوه مرستیال څخه: هو، د MCP له لارې.
• GET /v1/campaigns/segments — ستاسو د لیدونکو خوندي شوې برخې. عملیه listCampaignSegments. کتل شوې اجازې: campaigns.view. د AI له یوه مرستیال څخه: هو، د MCP له لارې.
• POST /v1/campaigns/segments — د لیدونکو یوه نوې برخه خوندي کړئ. عملیه createCampaignSegment. کتل شوې اجازې: campaigns.manage. د AI له یوه مرستیال څخه: هو، د MCP له لارې.
• GET /v1/campaigns/segments/fields — د فلټر لغت، د هغې د ارزښتونو لستونه او جادويي ټګونه. عملیه getCampaignSegmentFields. کتل شوي واکونه: campaigns.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/campaigns/segments/preview — دا څومره خلکو ته رسېږي، هغوی څوک دي، او څوک ترې بهر پاتې کېږي. عملیه previewCampaignSegment. کتل شوي واکونه: campaigns.view. د AI مرستیال څخه: هو، د MCP له لارې.
• DELETE /v1/campaigns/segments/{segmentId} — یوه برخه (segment) ارشیف کړئ. عملیه archiveCampaignSegment. کتل شوي واکونه: campaigns.manage. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/campaigns/segments/{segmentId} — یوه خوندي شوې برخه. عملیه getCampaignSegment. کتل شوي واکونه: campaigns.view. د AI مرستیال څخه: هو، د MCP له لارې.
• PATCH /v1/campaigns/segments/{segmentId} — د یوې برخې نوم بدل کړئ یا د هغې فلټرونه بدلون کړئ. عملیه updateCampaignSegment. کتل شوي واکونه: campaigns.manage. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/campaigns/suppressions — هغه پته‌ګانې چې باید بازارموندنه ترلاسه نه کړي. عملیه listCampaignSuppressions. کتل شوي واکونه: campaigns.view. د AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/campaigns/suppressions — د مخنیوي لست ته یوه پته اضافه کړئ. عملیه createCampaignSuppression. کتل شوي واکونه: campaigns.manage. د AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/campaigns/tags — د جادوئي ټګونو تخته چې د کمپاین جوړونکی یې وړاندې کوي. عملیه listCampaignTags. د AI معاون لخوا: هو، د MCP له لارې.
• GET /v1/campaigns/templates — د سازمان د کمپاین ټیمپلیټونه. عملیه listCampaignTemplates. د AI معاون لخوا: هو، د MCP له لارې.
• POST /v1/campaigns/templates — د کمپاین ټیمپلیټ جوړ کړئ. عملیه createCampaignTemplate. د AI معاون لخوا: هو، د MCP له لارې.
• DELETE /v1/campaigns/templates/{templateId} — یو ټیمپلیټ آرشیف کړئ او د هغې د ژباړې سرچینې تقاعد کړئ. عملیه archiveCampaignTemplate. د AI معاون لخوا: هو، د MCP له لارې.
• GET /v1/campaigns/templates/{templateId} — د کمپاین یو ټیمپلیټ. عملیه getCampaignTemplate. د AI معاون لخوا: هو، د MCP له لارې.
• PUT /v1/campaigns/templates/{templateId} — د کمپاین یو ټیمپلیټ ایډیټ کړئ. عملیه updateCampaignTemplate. د AI معاون لخوا: هو، د MCP له لارې.
• POST /v1/campaigns/unsubscribe — د بازارموندنې لیست پریږدئ. حساب ته اړتیا نشته. عملیه unsubscribeFromCampaigns. د AI معاون لخوا: یوازې API او ډشبورډ: دا یو پټ راز لیږدوي چې هیڅکله باید د AI ماډل ته ونه رسیږي (د ترلاسه کونکي لاسلیک شوی د غړیتوب لغوه کولو ټوکن اخلي).
• DELETE /v1/campaigns/{campaignId} — یو کمپاین حذف کړئ او د هغې د تحویل قطارونه تقاعد کړئ. عملیه deleteCampaign. د AI معاون لخوا: یوازې API او ډشبورډ: دا داسې اجازې ته اړتیا لري چې د AI اتصالاتو ته نه ورکول کیږي (د ESP کمپاین حذف کول campaigns.send ته اړتیا لري).
• GET /v1/campaigns/{campaignId} — یو کمپاین او د هغې د سپارلو راپور. عملیه getCampaign. د AI له مرستیال څخه: هو، د MCP له لارې.
• POST /v1/campaigns/{campaignId}/control — روان استول ځنډول، بیا پیل کول یا لغوه کول. عملیه controlCampaign. د AI له مرستیال څخه: یوازې API او ډشبورډ: دا پیسې یا کریډیټ مصرفوي، نو یو انسان یې کلیک کوي (ژوندی استول ځنډوي/بیا پیلوي).
• POST /v1/campaigns/{campaignId}/send — د دوامدار استولو پیل کول. عملیه sendCampaign. د AI له مرستیال څخه: یوازې API او ډشبورډ: دا پیسې یا کریډیټ مصرفوي، نو یو انسان یې کلیک کوي (حقیقي ترلاسه کوونکو ته د ESP کمپاین استوي).
• POST /v1/campaigns/{campaignId}/test — په هغه چینل کې یو حقیقي پیغام استول چې کمپاین به یې په واقعیت کې کاروي. عملیه testSendCampaign. د AI له مرستیال څخه: یوازې API او ډشبورډ: دا داسې اجازې ته اړتیا لري چې د AI اړیکو ته نه ورکول کیږي (یو ESP ازموینې استول campaigns.send ته اړتیا لري).

عامه پاڼې او راتلونکي ویب‌هوکس

• GET /v1/public/email-marketing/c/{token} — د کلیکونو شمېرونکی. په هر ترلاسه کوونکي یو کلیک ثبتوي او اصلي لینک ته یې بیا لارښوونه کوي. عملیه emailMarketingClick. د AI له مرستیال څخه: یوه پاڼه چې ستاسو ترلاسه کوونکي یې له بریښنالیک څخه پرانیزي (د کلیک تعقیبولو بیا لارښوونه).
• GET /v1/public/email-marketing/f/{public_id} — د ګډون د فورمې کوربه پاڼه (له ننوتلو پرته). عملیه emailMarketingFormPage. د AI له مرستیال څخه: یوه پاڼه چې ستاسو ترلاسه کوونکي یې له بریښنالیک څخه پرانیزي (د عامه ګډون د فورمې پاڼه).
• POST /v1/public/email-marketing/f/{public_id} — د نوم لیکنې یوه فورمه وسپارئ (کوربه شوې پاڼه، ځای پر ځای شوې یا JSON). عملیه emailMarketingFormSubmit. د یو هوښیار مرستیال (AI) له خوا: د بل سیسټم له خوا رابلل کیږي (یو چمتوکوونکی یا یو لیدونکی)، نه ستاسو له خوا (یو لیدونکی د نوم لیکنې فورمه سپاري).
• GET /v1/public/email-marketing/fc — د دوه پړاویزه رضایت (double opt-in) د تایید پاڼه (له ننوتلو پرته). عملیه emailMarketingFormConfirmPage. د یو هوښیار مرستیال (AI) له خوا: یوه پاڼه چې ستاسو ترلاسه کوونکي یې له یو بریښنالیک څخه پرانیزي (د دوه پړاویزه رضایت د تایید پاڼه).
• POST /v1/public/email-marketing/fc — نوم لیکنه تایید کړئ (شخص د رضایت له ریکارډ سره لیست ته اضافه کوي). عملیه emailMarketingFormConfirm. د یو هوښیار مرستیال (AI) له خوا: د بل سیسټم له خوا رابلل کیږي (یو چمتوکوونکی یا یو لیدونکی)، نه ستاسو له خوا (یو لیدونکی د دوه پړاویزه رضایت پخلی کوي).
• GET /v1/public/email-marketing/o/{token} — د پرانیستلو تعقیبونکی انځور (یو 1x1 GIF). د هر ترلاسه کوونکي لپاره یو ځل پرانیستل شمیري. عملیه emailMarketingOpenPixel. د یو هوښیار مرستیال (AI) له خوا: یوه پاڼه چې ستاسو ترلاسه کوونکي یې له یو بریښنالیک څخه پرانیزي (د پرانیستلو تعقیبونکی پکسل).
• GET /v1/public/email-marketing/u/{token} — د فوټر د ګډون لغوه کولو لینک (له ننوتلو پرته). عملیه emailMarketingUnsubscribePage. د یو هوښیار مرستیال (AI) له خوا: یوه پاڼه چې ستاسو ترلاسه کوونکي یې له یو بریښنالیک څخه پرانیزي (د ګډون لغوه کولو پاڼه).
• POST /v1/public/email-marketing/u/{token} — د RFC 8058 یو-کلیک ګډون لغوه کول (او د پاڼې د "هر څه بند کړئ" تڼۍ). عملیه emailMarketingUnsubscribeOneClick. د یو AI مرستیال لخوا: د بل سیسټم (یو چمتوکوونکي یا لیدونکي) لخوا غوښتل شوی، نه ستاسو لخوا (د RFC 8058 یو-کلیک ګډون لغوه کول).
• GET /v1/public/email-marketing/warmup-u/{token} — د بازارموندنې حوض د ګرمولو برېښنالیک د ګډون لغوه کولو لینک (بې له ننوتلو). عملیه emailMarketingWarmupUnsubscribePage. د یو AI مرستیال لخوا: هغه پاڼه چې ستاسو ترلاسه کوونکي یې له برېښنالیک څخه پرانیزي (د ګرمولو د ګډون لغوه کولو پاڼه).
• POST /v1/public/email-marketing/warmup-u/{token} — د ګرمولو له برېښنالیک څخه د RFC 8058 یو-کلیک ګډون لغوه کول. عملیه emailMarketingWarmupUnsubscribeOneClick. د یو AI مرستیال لخوا: د بل سیسټم (یو چمتوکوونکي یا لیدونکي) لخوا غوښتل شوی، نه ستاسو لخوا (د ګرمولو یو-کلیک ګډون لغوه کول).
• POST /v1/webhooks/campaign-events — د برېښنالیک چمتوکوونکي څخه د تسلیمۍ لاسلیک شوې پیښه جذب کړئ. عملیه receiveCampaignDeliveryWebhook. د یو AI مرستیال لخوا: د بل سیسټم (یو چمتوکوونکي یا لیدونکي) لخوا غوښتل شوی، نه ستاسو لخوا (لاسلیک شوی ESP تسلیمۍ وېبهوک).
• POST /v1/webhooks/campaigns/telnyx — زموږ د SMS پلورونکي څخه راتلونکي SMS ځوابونه (STOP / START). عملیه receiveCampaignsTelnyxInbound. د یو AI مرستیال لخوا: د بل سیسټم (یو چمتوکوونکي یا لیدونکي) لخوا غوښتل شوی، نه ستاسو لخوا (لاسلیک شوی Telnyx راتلونکی وېبهوک).
• POST /v1/webhooks/email-marketing/{connection_id} — د یو لېږونکي پیوستون لپاره د پیرودونکي د خپل برېښنالیک چمتو کونکي د تحویلۍ پیښې. عملیه receiveEmailMarketingProviderWebhook. د یو AI مرستیال څخه: د بل سیسټم لخوا غوښتل شوی (یو چمتو کونکی یا یو لیدونکی)، نه ستاسو لخوا (لاسلیک شوی لېږونکی-چمتو کونکی ویب‌هووک).

Flows

• GET /v1/email-marketing/flows — د برېښنالیک جریانونه (ښه راغلاست، ډریپ، کلنۍ نیټه)، د keyset یوه پاڼه. عملیه listEmailMarketingFlows. تایید شوي اجازې: email_marketing.view. د یو AI مرستیال څخه: هو، د MCP له لارې.
• POST /v1/email-marketing/flows — یو جریان جوړ کړئ (دا د مسودې په توګه پیل کیږي). عملیه createEmailMarketingFlow. تایید شوي اجازې: email_marketing.manage، email_marketing.view. د یو AI مرستیال څخه: هو، د MCP له لارې.
• DELETE /v1/email-marketing/flows/{flow_id} — یو جریان او د هغې نوم لیکنې ړنګې کړئ (د دې لېږل شوي اجراات د کمپاینونو په توګه پاتې کیږي). عملیه deleteEmailMarketingFlow. تایید شوي اجازې: email_marketing.manage، email_marketing.view. د یو AI مرستیال څخه: هو، د MCP له لارې.
• GET /v1/email-marketing/flows/{flow_id} — یو جریان د خپلو ګامونو او راپور سره (شامل شوي، د کار په جریان کې، په هر ګام کې اجراات او ترلاسه کوونکي). عملیه getEmailMarketingFlow. تایید شوي اجازې: email_marketing.view. د یو AI مرستیال څخه: هو، د MCP له لارې.
• PATCH /v1/email-marketing/flows/{flow_id} — یو بهیر بدل کړئ؛ steps، کله چې ورکړل شي، ټول تسلسل بدلوي. عملیه updateEmailMarketingFlow. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/flows/{flow_id}/activate — یو بهیر فعال کړئ؛ یوازې هغه کسان چې له دې وروسته لیست کې شاملېږي نومول کېږي. عملیه activateEmailMarketingFlow. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.
• POST /v1/email-marketing/flows/{flow_id}/pause — یو بهیر وځنډوئ؛ پاتې پړاوونه انتظار باسي او تر هغه وخته پورې چې بېرته فعال نه شي نوي کس ته بریښنالیک نه لیږل کېږي. عملیه pauseEmailMarketingFlow. چک شوي اجازې: email_marketing.manage, email_marketing.view. د AI مرستیال لخوا: هو، د MCP له لارې.