partner

POST `/v1/partner/customers`

Link (or create) the organization for one of your own customers.

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 \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "external_id": <string>, "email": <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

Idempotent on external_id — your own id for that customer. An email we do not know gets a new organization under yours, with a billing profile and no members; an email that already has a Zinn Digital® account is never taken on your say-so and answers 409, recording a consent request the customer answers in their own account. Requires partner.domains.

Request body

Name	Type	Required	What it is
`external_id`	`string`	Yes	Your own id for the customer.
`email`	`string`	Yes	—
`name`	`string`	No	—
`country`	`string`	No	ISO 3166-1 alpha-2. Used for tax determination and on the invoice.
`currency`	`string`	No	—

Response

Name	Type	Required	What it is
`external_id`	`string`	Yes	—
`org_id`	`string`	Yes	The organization you may act on, as `X-Zinn-Org`. Empty while the link is not active — a pending link names no organization you may use.
`state`	`string<active, pending_consent, revoked>`	Yes	—
`created_org`	`boolean`	Yes	Whether we made this organization for you, or the customer already had one.
`has_registrant`	`boolean`	Yes	Whether a registrant contact is on file. An order is refused until it is.
`email`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 409 · 422 · 429

POST /v1/partner/customers