members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Tabbatar da Asali

Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin members.invite; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.

Inda ID ɗin kungiyar ku ke zuwa

Wannan ma'ajiyar tana karɓar org_id a matsayin fili a cikin jikin JSON.

Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.

Gwada

May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.

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

An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API

Bayani

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.

Jikin buƙata

Suna	Nau'i	Ana buƙata	Abin da yake
`email`	`string`	Eh	—
`role`	`string`	Eh	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	A'a	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Martani

Suna	Nau'i	Ana buƙata	Abin da yake
`id`	`string`	Eh	—
`org_id`	`string`	Eh	—
`org_name`	`string`	Eh	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Eh	—
`role`	`string`	Eh	—
`site_grants`	`object[]`	Eh	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…
`status`	`string<pending, accepted, revoked>`	Eh	—
`expires_at`	`string`	Eh	—
`accepted_at`	`string`	A'a	—
`created_at`	`string`	Eh	—

Kuskuren da wannan matsaya za ta iya maido wa

401 · 403 · 422 · 429