Zinn® Campaigns API և MCP. մշակողի ուղեցույց

Այն ամենը, ինչ կարող եք անել կառավարման վահանակում Zinn® Campaigns-ում, կարող եք անել նաև API-ի միջոցով, իսկ դրա մեծ մասը՝ MCP-ի միջոցով Ձեր հաշվին միացված AI օգնականից: Այս ուղեցույցն ընդգրկում է մուտք գործելը, թույլտվությունները, գործնական օրինակ երկու եղանակով, սահմանաչափերը, սխալները և բոլոր 89 Campaigns գործողություններից յուրաքանչյուրը: Ստորև ներկայացված գործողությունների ցանկը ստեղծվել է մեր API-ի բնութագրից, ուստի այն միշտ համապատասխանում է նրան, ինչ անում է API-ը: Յուրաքանչյուր գործողության յուրաքանչյուր դաշտ առկա է API-ի տեղեկատուում՝ zinndigital.com/developers/api/zinn-campaigns հասցեով:

Մուտք գործելը

• 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 օգնականից

Հարցրեք Ձեր օգնականին պարզ բառերով, օրինակ՝ «կազմեք Zinn® Campaigns էլ․ նամակի սևագիր Գարնանային զեղչեր անվամբ և 'Մեր գարնանային զեղչերը սկսվում են այսօր' թեմայով»։ Կուլիսներում այն գտնում է գործողությունը 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 գաղտնաբառը, նույնպես երբեք չեն փոխանցվում օգնականի միջոցով. մուտքագրեք դրանք կառավարման վահանակում:

Սահմանափակումներ

• 1,200 հարցում րոպեում յուրաքանչյուր անձի կամ API բանալու համար, և 6,000 հարցում րոպեում յուրաքանչյուր կազմակերպության համար: Կիրառվում է երկուսից ավելի խիստը:
• 600 հարցում րոպեում յուրաքանչյուր MCP կապի համար:
• Սահմանաչափը գերազանցելու դեպքում պատասխանն է 429՝ Retry-After վերնագրով. սպասեք այդքան վայրկյան:
• Ցուցակի անդամներ ավելացնելիս մեկ հարցման համար թույլատրվում է առավելագույնը 1,000 հասցե. ձեր սակագնային պլանի կոնտակտների և էլփոստի սահմանաչափերը տարածվում են այն ամենի վրա, ինչ անում եք 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 վերնագրում նշված վայրկյանների քանակով:

Webhook-ներ

Առաքման արդյունքները Zinn® Campaigns են գալիս ձեր էլփոստն ուղարկող մատակարարից ներս.

• Ձեր սեփական մատակարարի դեպքում (օրինակ՝ Resend), պահեք դրա webhook-ի ստորագրման գաղտնաբառը կառավարման վահանակի ուղարկման կապի վրա (Campaigns → Sending): Դուք ստանում եք 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 — Էլ․ փոստի արշավներ, սկզբում նորերը, մեկ keyset էջ։ Գործողություն՝ 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 — Կազմակերպության կոնտակտները՝ մեկ անգամից բանալիների հավաքածուի (keyset) մեկ էջ: Գործողություն՝ 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 — Ավելացնել կոնտակտներ ցուցակում էլփոստի հասցեով (հարցման համար առավելագույնը 1,000)։ Գործողություն՝ 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 — Պահպանել Ձեր էլ. փոստի մատակարարի webhook-ի ստորագրման գաղտնիքն այս միացման համար: Գործողություն՝ setEmailMarketingSenderWebhook: Ստուգված թույլտվություններ՝ email_marketing.manage, email_marketing.view: AI օգնականից՝ կանչվում է այլ համակարգի կողմից (մատակարարի կամ այցելուի), ոչ թե Ձեր կողմից (պահպանում է մատակարարի webhook-ի գաղտնիքը):

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} — Արխիվացնել սեգմենտը: Գործողություն՝ 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):

Հանրային էջեր և մուտքային webhook-ներ

• 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 առաքման webhook):
• POST /v1/webhooks/campaigns/telnyx — Մուտքային SMS պատասխաններ (STOP / START) մեր SMS մատակարարից: Գործողություն՝ receiveCampaignsTelnyxInbound: AI օգնականից. կանչվում է մեկ այլ համակարգի (մատակարարի կամ այցելուի) կողմից, ոչ թե ձեր (ստորագրված Telnyx մուտքային webhook):
• POST /v1/webhooks/email-marketing/{connection_id} — Հաճախորդի սեփական էլփոստի մատակարարի առաքման իրադարձությունները մեկ ուղարկման կապի համար: Գործողություն՝ receiveEmailMarketingProviderWebhook: AI օգնականից՝ կանչվում է մեկ այլ համակարգի կողմից (մատակարարի կամ այցելուի), ոչ թե Ձեր կողմից (ստորագրված ուղարկող-մատակարար webhook):

Flows

• GET /v1/email-marketing/flows — Էլփոստի հոսքեր (ողջույնի, drip, տարեկան ամսաթիվ), ստեղնաշարի մեկ էջ: Գործողություն՝ 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-ի միջոցով: