డాష్బోర్డ్లో 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). యాప్ నుండి సైన్ ఇన్ చేయడం ద్వారా లేదా కనెక్షన్ టోకెన్ (
zmcp_live_…) ద్వారా Claude, ChatGPT, Cursor లేదా ఏదైనా MCP క్లయింట్ను https://api.zinndigital.com/v1/mcpకి కనెక్ట్ చేయండి. మీ ఖాతాకు 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 అసిస్టెంట్ నుండి అదే డ్రాఫ్ట్
మీ సహాయకుడిని సాధారణ పదాలలో అడగండి, ఉదాహరణకు "'Our spring sale starts today' అనే సబ్జెక్ట్తో Spring sale అని పిలవబడే 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 పాస్వర్డ్ వంటి రహస్యాలు కూడా సహాయకుడి ద్వారా ఎప్పుడూ పంపబడవు: వాటిని డాష్బోర్డ్లో నమోదు చేయండి.
పరిమితులు
- ప్రతి వ్యక్తి లేదా API కీకి నిమిషానికి 1,200 అభ్యర్థనలు, మరియు ప్రతి సంస్థకు నిమిషానికి 6,000 అభ్యర్థనలు. ఈ రెండింటిలో ఏది కఠినమైనదో అది వర్తిస్తుంది.
- ప్రతి MCP కనెక్షన్కు నిమిషానికి 600 అభ్యర్థనలు.
- పరిమితిని మించితే, ప్రతిస్పందన
Retry-After శీర్షికతో 429 గా ఉంటుంది: అన్ని సెకన్లు వేచి ఉండండి.
- జాబితా సభ్యులను జోడించడం ఒక అభ్యర్థనకు గరిష్టంగా 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 హెడర్లోని సెకన్ల సంఖ్య వరకు వేచి ఉండండి.
Webhooks
మీ ఇమెయిల్ను పంపే ప్రొవైడర్ నుండి డెలివరీ ఫలితాలు Zinn® Campaignsలోకి వస్తాయి:
- మీ స్వంత ప్రొవైడర్తో (ఉదాహరణకు Resend), డాష్బోర్డ్లోని (Campaigns → Sending) పంపే కనెక్షన్లో దాని webhook సైనింగ్ రహస్యాన్ని భద్రపరచండి. మీకు
webhook_url లభిస్తుంది; ప్రొవైడర్ యొక్క డెలివరీ చేయబడిన, బౌన్స్ అయిన మరియు ఫిర్యాదు చేయబడిన ఈవెంట్లను దీనికి సూచించండి. బౌన్స్ లేదా స్పామ్ ఫిర్యాదు భవిష్యత్ పంపకాల నుండి ఆ చిరునామాను వెంటనే తొలగిస్తుంది.
- 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 సందేశాలు, సరికొత్తవి మొదటగా, ఒక keyset పేజీ. ఆపరేషన్ 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 అవసరం).
పబ్లిక్ పేజీలు మరియు ఇన్కమింగ్ వెబ్హుక్స్
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 — డబుల్ ఆప్ట్-ఇన్ నిర్ధారణ పేజీ (లాగిన్ అవసరం లేదు). ఆపరేషన్ 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 అసిస్టెంట్ నుండి: వేరొక సిస్టమ్ ద్వారా కాల్ చేయబడుతుంది (ప్రొవైడర్ లేదా సందర్శకుడు), మీ ద్వారా కాదు (సంతకం చేసిన పంపినవారు-ప్రొవైడర్ వెబ్హుక్).
ఫ్లోలు
GET /v1/email-marketing/flows — ఇ-మెయిల్ ఫ్లోలు (స్వాగతం, డ్రిప్, వార్షిక తేదీ), ఒక కీసెట్ పేజీ. ఆపరేషన్ 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 ద్వారా.