zinn-campaigns
POST /v1/email-marketing/sms/registrations/us
Submit this organisation's brand and campaign for US 10DLC (charged on submit).
Authentication
Send an API key as a bearer token. The key must carry the email_marketing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/email-marketing/sms/registrations/us \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "fees_acknowledged": <boolean<True>>, "brand": <object>, "campaign": <object> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Gated on email_marketing.manage, and only while SMS is open to the organisation. The quote's upfront price is taken from the Zinn® credit balance now (nothing in test mode); the brand and campaign go to the provider in the background (202), and the carriers' review takes days. If the provider refuses the details, or the carriers reject the campaign, the part of the price the provider did not bill is returned. Once approved, a US number is assigned and US opens for this organisation only; the monthly price is then taken each month (an unpaid month closes US again). Refusals: CAMPAIGNS_ALREADY_REGISTERED (409), CAMPAIGNS_NO_CREDIT (402), CAMPAIGNS_NOT_OPEN / CAMPAIGNS_ACCOUNT_ON_HOLD (403), CAMPAIGNS_UNPRICED (503). Audited (email_marketing.registration.submit).
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | 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 agency… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
fees_acknowledged | boolean<True> | Yes | The customer ticked that the quote's nonrefundable_price_usd_micros is not refunded once submitted. |
brand | object | Yes | — |
campaign | object | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
country | string<US> | Yes | — |
status | string<submitting, pending, approved, rejected, lapsed> | Yes | submitting and pending are shown as waiting; approved means US is open to this organisation from phone_number; rejected and lapsed carry a reason_code. |
test | boolean | Yes | A test registration (free, never sent to the carriers, never opens US). |
brand_name | string | Yes | — |
usecase | string | Yes | — |
reason_code | string<details_invalid, brand_identity, campaign_rejected, carrier_rejected, suspended, renewal_unpaid> | Yes | — |
vendor_reason | string | Yes | The provider's own sentence (English), shown as a quotation. |
phone_number | string | Yes | — |
price_usd_micros | integer | Yes | — |
refunded_usd_micros | integer | Yes | — |
paid_through | string | Yes | — |
created_at | string | Yes | — |
updated_at | string | Yes | — |
Errors this endpoint can return
401 · 402 · 403 · 409 · 422 · 503