members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Autentifikatsiya

API kalitini bearer token sifatida yuboring. Kalit members.invite ruxsatiga ega boʻlishi shart; ruxsatsiz kalit 404 emas, balki 403 xatosi bilan rad etiladi.

Tashkilotingiz identifikatori kiritiladigan joy

Ushbu so'rov JSON tanasida org_id ni maydon sifatida qabul qiladi.

Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.

Sinab ko'rish

Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.

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> }'

Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching

Tafsilotlar

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.

Soʻrov tanasi

Nomi	Turi	Majburiy	Nima bu
`email`	`string`	Ha	—
`role`	`string`	Ha	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Yo'q	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Javob

Nomi	Turi	Majburiy	Nima bu
`id`	`string`	Ha	—
`org_id`	`string`	Ha	—
`org_name`	`string`	Ha	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Ha	—
`role`	`string`	Ha	—
`site_grants`	`object[]`	Ha	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>`	Ha	—
`expires_at`	`string`	Ha	—
`accepted_at`	`string`	Yo'q	—
`created_at`	`string`	Ha	—

Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar

401 · 403 · 422 · 429