members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen members.invite; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si fushë në trupin JSON.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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.

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`email`	`string`	Po	—
`role`	`string`	Po	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Jo	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`id`	`string`	Po	—
`org_id`	`string`	Po	—
`org_name`	`string`	Po	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Po	—
`role`	`string`	Po	—
`site_grants`	`object[]`	Po	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>`	Po	—
`expires_at`	`string`	Po	—
`accepted_at`	`string`	Jo	—
`created_at`	`string`	Po	—

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 422 · 429