seo-connect
POST /v1/seo-connection/offers/orders/{orderId}/placement
Where a bought link went live; watched by link watch from now on.
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; 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/seo-connection/offers/orders/{orderId}/placement \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "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
Needs the seo.run scope, and a paid link or citation order. The page must be on another website. The link (page, the order's target address and anchor) joins the site's watched links, checked like every other watched link.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orderId (path) | Uuid | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
url | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
offer | SeoOfferKey | Yes | — |
ledger | string | Yes | — |
product | string | Yes | — |
kind | string | Yes | — |
label | string | Yes | — |
context | object | Yes | — |
url | string | Yes | Where the order continues — opened in a new tab. |
status | string<opened, basket, awaiting_payment, payment_failed, paid, brief_needed, in_progress, delivered, done, disputed, cancelled, refunded, expired> | Yes | — |
total_minor | object | No | — |
tax_minor | object | No | — |
currency | string | No | — |
order_id | string | No | — |
sale_id | string | No | — |
placement_url | string | No | — |
watched | boolean | Yes | — |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422