members

POST /v1/members/invitations/{invitationId}/accept

Accept an invitation addressed to your email.

All members endpoints

All developer docs →

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

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/members/invitations/{invitationId}/accept \
  -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

Accepts an invitation whose email matches the caller's verified email, joining the organization with the invited role. The email match is the authorization — there is no secret token. Refuses an expired, revoked, already-accepted, or wrong-email invitation (422). Idempotent on the resulting membership.

Parameters

NameTypeRequiredWhat it is
invitationId (path)stringYesThe invitation's id.

Response

NameTypeRequiredWhat it is
idstringYes—
org_idstringYes—
org_namestringYesThe inviting organisation's display name, so an invitee can answer "accept?".
emailstringYes—
rolestringYes—
site_grantsobject[]YesThe individual sites this invitation lends, when it was created by sharing a site with an address that had no account (POST /v1/sites/{siteId}/collaborators). Empty for an…
statusstring<pending, accepted, revoked>Yes—
expires_atstringYes—
accepted_atstringNo—
created_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 422