seo-connect

POST /v1/seo-connection/reports/portal-links

A read-only page for the client, no login (zs-421).

All seo-connect endpoints

All developer docs →

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/reports/portal-links \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Zinn® SEO stage P12. Same as createClientPortalLink for this site's client. Needs seo.run.

Request body

NameTypeRequiredWhat it is
labelstringNo—
expires_in_daysobjectNo—

Response

NameTypeRequiredWhat it is
idstringYes—
client_idstringYes—
labelstringYes—
urlobjectYesnull once revoked or expired.
livebooleanYes—
expires_atobjectYes—
revoked_atobjectYes—
viewsintegerYes—
last_viewed_atobjectYes—
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429