members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na members.invite; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Kung saan mapupunta ang id ng iyong organisasyon

Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`email`	`string`	Oo	—
`role`	`string`	Oo	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Hindi	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`string`	Oo	—
`org_id`	`string`	Oo	—
`org_name`	`string`	Oo	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Oo	—
`role`	`string`	Oo	—
`site_grants`	`object[]`	Oo	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>`	Oo	—
`expires_at`	`string`	Oo	—
`accepted_at`	`string`	Hindi	—
`created_at`	`string`	Oo	—

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422 · 429