zinn-campaigns
PUT /v1/email-marketing/sms/sender-id
Set this organisation's own SMS sender name (alphanumeric sender ID).
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 PUT https://api.zinndigital.com/v1/email-marketing/sms/sender-id \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "sender_id": <string> }'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. Texts go out under the customer's OWN name, never Zinn®'s: where a country allows an alphanumeric sender ID (sender_id_countries on GET /v1/email-marketing/sms), this is the name the handset shows. 3 to 11 letters, digits or spaces, with at least one letter; Zinn®'s own names are refused. An empty sender_id clears it, and SMS to those countries is then refused with own_sender_required before any credit is taken. Refusal: CAMPAIGNS_SENDER_ID_INVALID (400, details[].code says why). Audited (email_marketing.sms.sender_id.update).
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 |
|---|---|---|---|
sender_id | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
sender_request_countries | string[] | Yes | Countries that open once this organisation's own sender name is registered there (POST /v1/email-marketing/sms/sender-requests). Approvals can take a few days. |
sender_requests | EmailMarketingSenderRequest[] | Yes | The latest request per country. |
sender_id | string | Yes | The alphanumeric SMS sender ID ("" when not set). |
sender_id_countries | string[] | Yes | Countries where sender_id is used. Others need a registered number. |
whatsapp_connected | boolean | Yes | The organisation's own WhatsApp Business Account is connected. |
whatsapp_display_phone | string | Yes | — |
whatsapp_health | EmailMarketingWhatsappHealth | Yes | Whether Meta lets the organisation's OWN WhatsApp Business Account send (docs/1052 §3.5j), as last read (checked_at). blocked: Meta refuses its messages and our sends are… |
whatsapp_signup | object | Yes | What the browser needs to open Meta's Embedded Signup window (our app id and its signup configuration id); null when WhatsApp signup is not offered yet. |
Errors this endpoint can return
400 · 401 · 403