members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Xaqiijinta aqoonsiga

U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda members.invite; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.

Meesha aqoonsiga ururkaagu galayo

Boggan waxaa uu qaataa org_id oo ah goob ku jirta JSON body.

Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.

Isku day

Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.

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

Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API

Details

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.

Codsiga jidhkiisa

Magaca	Nooc	Loo baahan yahay	Maxay tahay
`email`	`string`	Haa	—
`role`	`string`	Haa	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Maya	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Jawaab

Magaca	Nooc	Loo baahan yahay	Maxay tahay
`id`	`string`	Haa	—
`org_id`	`string`	Haa	—
`org_name`	`string`	Haa	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Haa	—
`role`	`string`	Haa	—
`site_grants`	`object[]`	Haa	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>`	Haa	—
`expires_at`	`string`	Haa	—
`accepted_at`	`string`	Maya	—
`created_at`	`string`	Haa	—

Cilladaha ay bartaani soo celin karto

401 · 403 · 422 · 429