members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Autentifikacija

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

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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 nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`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	Što je to
`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…
`status`	`string<pending, accepted, revoked>`	Da	—
`expires_at`	`string`	Da	—
`accepted_at`	`string`	Ne	—
`created_at`	`string`	Da	—

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 422 · 429