access

DELETE `/v1/orgs/{orgId}/members/{userId}`

Remove a member and offboard them (docs/35

Authentication

Send an API key as a bearer token. The key must carry the members.remove permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X DELETE https://api.zinndigital.com/v1/orgs/{orgId}/members/{userId} \
  -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

Removes the user from the org and runs the offboarding cascade: revokes their org access (immediate — a principal is resolved fresh per request), their Keycloak sessions (best-effort), and their own API keys, and emits `member.removed` so the hosting side rotates their per-site credentials. Audit-logged with the remover. Requires `members.remove`. Refuses (403) to remove a member more privileged than the caller, and (409) to remove the org's last owner.

Parameters

Name	Type	Required	What it is
`orgId (path)`	`Uuid`	Yes	Organization ID (UUIDv7).
`userId (path)`	`Uuid`	Yes	The user to remove from the organization.

Errors this endpoint can return

401 · 403 · 404 · 409 · 429