members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте members.invite рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.

Сіздің ұйым идентификаторыңыз басқару панеліндегі 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.

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`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.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`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