partner
POST /v1/partner/customers/{externalId}/consent-request
Ask a customer who already has an account again for their consent.
Authentication
Send an API key as a bearer token. The key must carry the partner.domains 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/partner/customers/{externalId}/consent-request \
-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
E-mails the owners of the organization that address owns a single-use link to accept or decline your access; the first request is sent automatically when linking answers 409. Asking again retires the previous link. At most one request every 15 minutes and five a day per customer (429 with Retry-After). A customer who declined cannot be asked again (422). 503 means the e-mail could not be sent and no link is live. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
state | string | Yes | — |
sent | boolean | Yes | — |
expires_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503