members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл members.invite; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоінт приймає org_id як поле в тілі JSON.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`email`	`string`	Так	—
`role`	`string`	Так	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Ні	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`org_id`	`string`	Так	—
`org_name`	`string`	Так	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Так	—
`role`	`string`	Так	—
`site_grants`	`object[]`	Так	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>`	Так	—
`expires_at`	`string`	Так	—
`accepted_at`	`string`	Ні	—
`created_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 422 · 429