ads

POST /v1/ads/client-approval-links/{link_id}/revoke

Stop a client approval link working, now (za-104).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

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 POST https://api.zinndigital.com/v1/ads/client-approval-links/{link_id}/revoke \
  -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 on the link's client org (else 404). Twice is once. Audit action ads.client_approval_link_revoked.

Parameters

NameTypeRequiredWhat it is
link_id (path)stringYes—

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYesThe CLIENT org the link reaches.
labelstringYes—
created_bystringYes—
created_atstringYes—
expires_atstringYes—
revoked_atobjectYes—
last_used_atobjectYes—
decisionsintegerYes—
livebooleanYes—
urlstringNoOnly in the 201 that made the link — the token is never stored and cannot be shown again. On the agency's own panel address once that address is live.

Errors this endpoint can return

401 · 404 · 429