access

POST /v1/access/impersonation/end

Exit the current impersonation session (revoke).

All access endpoints

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/access/impersonation/end \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Ends the calling impersonation session. Marking the grant ended **is** the revocation: the authenticator re-reads the row on every request, so the token stops working on the very next call rather than when it happens to expire. Audit-logged with the real staff actor. Returns 409 if the caller is not in an impersonation session.

Request body

NameTypeRequiredWhat it is
refresh_tokenstringNoIgnored. There is no upstream session to revoke.

Response

NameTypeRequiredWhat it is
endedbooleanYes

Errors this endpoint can return

401 · 409 · 429 · 503