Campaigns
DELETE /v1/campaigns/esp
Disconnect the provider account and remove its stored key.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X DELETE https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
Forget this organisation's e-mail provider. The stored key is removed from Vault, not merely hidden — and campaigns refuse to send until a provider is connected again.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
org_id (query) | Uuid | नहीं | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
connected | boolean | हाँ | — |
id | string | नहीं | — |
provider | string | हाँ | — |
status | string<not_connected, unverified, verified, rejected> | हाँ | — |
from_address | string | नहीं | — |
from_local_part | string | नहीं | — |
from_display_name | string | नहीं | — |
sending_domain | string | नहीं | — |
reply_to | string | नहीं | — |
verified_domains | EspVerifiedDomain[] | नहीं | — |
last_verified_at | string | नहीं | — |
last_error | string | नहीं | — |
stats | CampaignDeliveryCounts | नहीं | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403