partner
POST /v1/partner/customers/{externalId}/panel-invite
Give your customer a way into their own control panel.
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}/panel-invite \
-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
Invites the e-mail address the customer is linked with to their organization as its owner, and returns accept_url — send it in your own message. They sign in or sign up with that address and land in their panel; the verified e-mail is the authorisation, so the link is not a secret. A customer who already belongs to the organization gets status: already_member and the panel address. Repeating the call returns the same pending invitation. 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 |
|---|---|---|---|
status | string<invited, already_member> | Yes | — |
invitation_id | object | Yes | — |
accept_url | string | Yes | — |
email | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429