notifications
GET /v1/outbound-mail
The mail service this organisation sends through.
ప్రమాణీకరణ
ఒక API కీని బేరర్ టోకెన్గా పంపండి. ఈ ఎండ్పాయింట్ స్పెసిఫికేషన్లో నిర్దిష్ట అనుమతిని పేర్కొనలేదు, కాబట్టి ఊహించడం కంటే మీ కీకి అవసరమైన కనిష్ట అనుమతిని ఇవ్వండి మరియు ప్రతిస్పందనను తనిఖీ చేయండి.
మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ
ఈ ఎండ్పాయింట్ క్వరీ పారామీటర్గా org_idని తీసుకుంటుంది. దీనిని వదిలేస్తే కాల్ మీ మొత్తం టెనెన్సీ సబ్ట్రీని కవర్ చేస్తుంది; ఒకే సంస్థకు కాల్ని పరిమితం చేయడానికి దీన్ని పంపండి.
మీ సంస్థ ఐడి (organisation id) మీ డాష్బోర్డ్లోని API కీస్ స్క్రీన్పై, కీ పక్కనే ఉంటుంది. మీరు చేసే ప్రతి కాల్లోనూ ఇదే ఐడి ఉపయోగించబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
curl -X GET https://api.zinndigital.com/v1/outbound-mail \
-H "Authorization: Bearer zdk_live_…"సైన్ ఇన్ చేశారా? మీ డ్యాష్బోర్డ్లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్పాయింట్ను API కన్సోల్లో తెరిచండి
వివరాలు
Agencies and resellers send their notifications through their OWN mail provider, at their own cost. This returns what is attached, whether it has been verified, and the form definition for every provider we support. An organisation with nothing attached gets account: null and a fallback_notice saying in as many words that its mail is going out from the platform's domain on the platform's account. That sentence is part of the contract, not decoration: an empty state that does not say who is paying reads as "nothing to do here".
పారామీటర్లు
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
org_id (query) | string | కాదు | The organization to act on. Omitted (or empty) means your own. |
స్పందన
| పేరు | రకం | కావలసినది | ఇది ఏమిటి |
|---|---|---|---|
can_configure | boolean | అవును | Whether this organisation's plan includes its own sending identity - the agency and reseller plans do, a plain client plan does not. A claim about the PLAN, never the… |
account | OutboundMailAccount | అవును | null when this organisation sends on the platform's account. |
providers | object[] | అవును | The provider catalogue AND the fields each one needs, served from the same definition the API validates against - so the form a customer fills in and the rules it must satisfy… |
sending_as | string<own, platform> | అవును | Who is actually paying for this organisation's mail right now. platform whenever no account is attached OR the attached one has not completed its round trip. |
fallback_notice | string | అవును | Plain-language explanation shown when sending_as is platform; empty otherwise. Part of the contract rather than presentation - an empty state that does not say who is paying… |
client_orgs_held | integer | అవును | How many client organisations under this one currently have their non-essential notifications held because no own mail provider is connected (owner ruling 2026-09-03). 0 when a… |