notifications
POST /v1/outbound-mail/verify
Enter the code from the test message.
ਪ੍ਰਮਾਣੀਕਰਨ
ਇੱਕ API ਕੁੰਜੀ ਨੂੰ ਬੀਅਰ ਟੋਕਨ ਵਜੋਂ ਭੇਜੋ। ਇਹ ਐਂਡਪੁਆਇੰਟ ਸਪੈਸੀਫਿਕੇਸ਼ਨ ਵਿੱਚ ਕਿਸੇ ਖਾਸ ਇਜਾਜ਼ਤ ਨੂੰ ਨਹੀਂ ਦਰਸਾਉਂਦਾ, ਇਸ ਲਈ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਘੱਟੋ-ਘੱਟ ਲੋੜੀਂਦੀਆਂ ਇਜਾਜ਼ਤਾਂ ਦਿਓ ਅਤੇ ਮੰਨਣ ਦੀ ਬਜਾਏ ਜਵਾਬ ਦੀ ਜਾਂਚ ਕਰੋ।
ਜਿੱਥੇ ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਆਉਂਦੀ ਹੈ
ਇਹ ਐਂਡਪੁਆਇੰਟ org_id ਨੂੰ ਇੱਕ ਕੌਂਸਲ ਪੈਰਾਮੀਟਰ ਵਜੋਂ ਲੈਂਦਾ ਹੈ। ਇਸਨੂੰ ਛੱਡ ਦਿਓ ਅਤੇ ਕਾਲ ਤੁਹਾਡੇ ਪੂਰੇ ਟੈਨੈਂਸੀ ਸਬਟ੍ਰੀ ਨੂੰ ਕਵਰ ਕਰੇਗੀ; ਕਾਲ ਨੂੰ ਇੱਕ ਸੰਸਥਾ ਤੱਕ ਸੀਮਤ ਕਰਨ ਲਈ ਇਸਨੂੰ ਭੇਜੋ।
ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ 'ਤੇ API ਕੁੰਜੀਆਂ ਵਾਲੀ ਸਕ੍ਰੀਨ 'ਤੇ, ਕੁੰਜੀ ਦੇ ਬਿਲਕੁਲ ਨਾਲ ਮੌਜੂਦ ਹੈ। ਇਹ ਤੁਹਾਡੇ ਵੱਲੋਂ ਕੀਤੀ ਜਾਣ ਵਾਲੀ ਹਰ ਕਾਲ ਵਿੱਚ ਉਹੀ ਆਈਡੀ ਹੁੰਦੀ ਹੈ।
ਕੋਸ਼ਿਸ਼ ਕਰੋ
ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।
curl -X POST https://api.zinndigital.com/v1/outbound-mail/verify \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "code": <string> }'ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation id) ਅਤੇ ਤੁਹਾਡੀ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਭਰਦਾ ਹੈ, ਅਤੇ ਲਾਈਵ API ਦੇ ਵਿਰੁੱਧ ਬੇਨਤੀ ਚਲਾਉਂਦਾ ਹੈ ਤਾਂ ਜੋ ਤੁਸੀਂ ਅਸਲ ਜਵਾਬ ਦੇਖ ਸਕੋ। API ਕੰਸੋਲ ਵਿੱਚ ਇਸ ਐਂਡਪੁਆਇੰਟ ਨੂੰ ਖੋਲ੍ਹੋ
ਵੇਰਵੇ
Completes the round trip. On success the account becomes the From address for every notification this organisation's brand sends, and the platform stops paying for them. The code expires after an hour and survives five wrong attempts, after which a fresh test message is required. Each refusal says which of the three it is, because "that did not work" about a code with a TTL and an attempt limit is three problems with three different remedies.
ਪੈਰਾਮੀਟਰ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
org_id (query) | string | ਨਹੀਂ | The organization to act on. Omitted means your own. |
ਬੇਨਤੀ ਬਾਡੀ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
code | string | ਹਾਂ | — |
ਜਵਾਬ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
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 authorisat… |
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 c… |
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… |