members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin members.invite; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor 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 masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`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.

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`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	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429