તમે ડૅશબોર્ડ પર 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 સહાયક તરફથી એ જ ડ્રાફ્ટ
તમારા સહાયકને સરળ શબ્દોમાં પૂછો, ઉદાહરણ તરીકે "'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 હેડરમાં આપેલી સેકંડની સંખ્યા જેટલી રાહ જુઓ.
વેબહૂક્સ
ડિલિવરી પરિણામો તમારા ઇમેઇલ મોકલતા પ્રદાતા તરફથી Zinn® Campaigns માં આવે છે:
- તમારા પોતાના પ્રદાતા સાથે (ઉદાહરણ તરીકે Resend), ડેશબોર્ડમાં મોકલવાના કનેક્શન પર તેનું વેબહૂક સાઇનિંગ સિક્રેટ સંગ્રહિત કરો (અભિયાનો → મોકલવું). તમને એક
webhook_url મળે છે; પ્રદાતાની delivered, bounced અને complained ઇવેન્ટ્સને તેના તરફ નિર્દેશિત કરો. બાઉન્સ અથવા સ્પામ ફરિયાદ ભવિષ્યના મોકલવા માટેના સરનામાંને તરત જ દૂર કરે છે.
- Zinn® મોકલવા સાથે, કંઈપણ સેટઅપ કરવાનું નથી.
રિપોર્ટ ઑપરેશન્સ સાથે પરિણામો વાંચો (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
દરેક અભિયાનો ઑપરેશન
ઝાંખી
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 — Zinn® ક્રેડિટ બૅલેન્સમાંથી ચૂકવેલ, એક સંપર્કને એક SMS મોકલો. ઑપરેશન 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 — ભૂતકાળની સંપર્ક આયાતો, સૌથી નવી પ્રથમ, એક સમયે એક કીસેટ પૃષ્ઠ. ઑપરેશન 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 ઝુંબેશો, સૌથી નવી પ્રથમ, એક કીસેટ પૃષ્ઠ. ઑપરેશન 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 મારફતે.