ਹਰ ਉਹ ਕੰਮ ਜੋ ਤੁਸੀਂ ਡੈਸ਼ਬੋਰਡ 'ਤੇ 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 ਸਹਾਇਕ ਤੋਂ ਇਹੀ ਡਰਾਫਟ
ਆਪਣੇ ਸਹਾਇਕ ਨੂੰ ਸਰਲ ਸ਼ਬਦਾਂ ਵਿੱਚ ਪੁੱਛੋ, ਉਦਾਹਰਨ ਲਈ "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 ਕੁੰਜੀ ਲਈ 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 — ਈ-ਮੇਲ ਮੁਹਿੰਮਾਂ, ਸਭ ਤੋਂ ਨਵੀਆਂ ਪਹਿਲਾਂ, ਇੱਕ ਕੀਸੈੱਟ ਸਫ਼ਾ। ਕਾਰਵਾਈ 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 — ਈ-ਮੇਲ ਪਤੇ ਰਾਹੀਂ ਕਿਸੇ ਸੂਚੀ ਵਿੱਚ ਸੰਪਰਕ ਸ਼ਾਮਲ ਕਰੋ (ਪ੍ਰਤੀ ਬੇਨਤੀ ਵੱਧ ਤੋਂ ਵੱਧ 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 — ਇਸ ਕਨੈਕਸ਼ਨ ਲਈ ਆਪਣੇ ਈਮੇਲ ਪ੍ਰਦਾਤਾ ਦੇ ਵੈੱਬਹੁੱਕ ਸਾਈਨਿੰਗ ਸੀਕ੍ਰੇਟ ਨੂੰ ਸਟੋਰ ਕਰੋ। ਓਪਰੇਸ਼ਨ 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 — ਦਬਾਉਣ ਸੂਚੀ (suppression list) ਵਿੱਚ ਇੱਕ ਪਤਾ ਸ਼ਾਮਲ ਕਰੋ। ਕਾਰਵਾਈ 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 ਸਹਾਇਕ ਵੱਲੋਂ: ਕਿਸੇ ਹੋਰ ਸਿਸਟਮ ਦੁਆਰਾ ਕਾਲ ਕੀਤਾ ਗਿਆ (ਇੱਕ ਪ੍ਰਦਾਤਾ ਜਾਂ ਵਿਜ਼ਿਟਰ), ਤੁਹਾਡੇ ਦੁਆਰਾ ਨਹੀਂ (ਦਸਤਖਤ ਕੀਤਾ ਭੇਜਣ ਵਾਲਾ-ਪ੍ਰਦਾਤਾ ਵੈੱਬਹੁੱਕ)।
Flows
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 ਰਾਹੀਂ।