members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran members.invite; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai medan dalam kandungan JSON.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

curl -X POST https://api.zinndigital.com/v1/members/invitations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "role": <string> }'

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

Invites an **email** (the person need not exist yet — users are Keycloak subjects) to join with a role. The role is validated to be one the inviter is themselves permitted to grant: a role holding any permission the inviter lacks in that organization is refused (422), so `members.invite` is not a ladder to owner. A re-invite of the same email refreshes the pending invite. Emits `member.invited` so the invitation email is sent. Requires `members.invite` in the target org.

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`email`	`string`	Ya	—
`role`	`string`	Ya	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Tidak	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Respons

Nama	Jenis	Diperlukan	Apakah ia
`id`	`string`	Ya	—
`org_id`	`string`	Ya	—
`org_name`	`string`	Ya	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Ya	—
`role`	`string`	Ya	—
`site_grants`	`object[]`	Ya	The 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 ord…
`status`	`string<pending, accepted, revoked>`	Ya	—
`expires_at`	`string`	Ya	—
`accepted_at`	`string`	Tidak	—
`created_at`	`string`	Ya	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429