ads
POST /v1/public/ads-wordpress/claim
The Zinn® Ads plugin exchanges a one-time code for its site token.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
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/public/ads-wordpress/claim \
-H "Content-Type: application/json" \
-d '{ "code": <string>, "site_url": <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
⛔ No authentication — the one-time code is the whole authorisation (docs/1006 §102). Unknown, used and expired codes are one answer (422 codeInvalid). The token is returned ONCE; we keep only its SHA-256 hash. Re-connecting a host that is already connected retires its old token in the same step. Audit action ads.wordpress_site_connected.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
code | string | Yes | — |
site_url | string | Yes | The site's home_url(). |
plugin_version | string | No | — |
wp_version | string | No | — |
cloudflare | boolean | No | A CF-Ray header reached PHP. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
token | string | Yes | zwp_… — store it; it is never shown again. |
config | AdsWordPressConfig | Yes | What the Zinn® Ads plugin needs to run. Public ids only, never a credential. |
Errors this endpoint can return
422 · 429