ads
DELETE /v1/ads/connections/{connection_id}/call-numbers/{number_id}
Release a tracking number — it stops costing anything (za-160).
Authentication
Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X DELETE https://api.zinndigital.com/v1/ads/connections/{connection_id}/call-numbers/{number_id} \
-H "Authorization: Bearer zdk_live_…"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 ads.manage; audit action ads.call_number_released. The number is marked releasing and given back to the voice vendor by a Temporal workflow; no further month is charged.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
number_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
connection_id | string | Yes | — |
name | string | Yes | — |
phone_number | string | Yes | — |
country | string | Yes | — |
forward_to | string | Yes | Where calls are forwarded; "" = forwarding switched off (calls refused unanswered). |
status | string<ordering, active, suspended, releasing, released, failed> | Yes | — |
monthly_usd_micros | integer | Yes | — |
paid_through | string | Yes | — |
suspended_at | string | Yes | — |
calls | integer | Yes | — |
refused_calls | integer | Yes | — |
ordered_at | string | Yes | — |
released_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429