partner

POST /v1/partner-consents/{token}

Accept or decline a partner's request to act for your organization.

All partner endpoints

All developer docs

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/partner-consents/{token} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "decision": <string<accept, decline>> }'

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

accept lets the partner register domains in this organization (each order paid by you on our payment page), manage their DNS and nameservers and see its sites, domains and invoices; decline is final for that partner. The link works once. The same membership rule as reading it applies.

Parameters

NameTypeRequiredWhat it is
token (path)stringYes

Request body

NameTypeRequiredWhat it is
decisionstring<accept, decline>Yes

Response

NameTypeRequiredWhat it is
statestring<active, declined>Yes
partnerstringYes

Errors this endpoint can return

401 · 403 · 404 · 409 · 422