members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Autentifikacija

Pošaljite API ključ kao bearer token. Ključ mora imati dozvolu members.invite; ključ bez nje se odbija sa 403, a ne sa 404.

Gde ide ID vaše organizacije

Ova krajnja tačka prihvata org_id kao polje u JSON telu.

ID vaše organizacije nalazi se na ekranu sa API ključevima u vašoj kontrolnoj tabli, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

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

Prijavljeni ste? API konzola na vašoj kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Detalji

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.

Telo zahteva

Naziv	Vrsta	Obavezno	Šta je ovo
`email`	`string`	Da	—
`role`	`string`	Da	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Ne	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Odgovor

Naziv	Vrsta	Obavezno	Šta je ovo
`id`	`string`	Da	—
`org_id`	`string`	Da	—
`org_name`	`string`	Da	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Da	—
`role`	`string`	Da	—
`site_grants`	`object[]`	Da	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>`	Da	—
`expires_at`	`string`	Da	—
`accepted_at`	`string`	Ne	—
`created_at`	`string`	Da	—

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 422 · 429