members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

அங்கீகாரம்

பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை members.invite அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.

உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்

இந்த எண்ட்ஸ்பாயிண்ட் JSON பாடியில் உள்ள ஒரு புலமாக org_id-ஐ எடுத்துக்கொள்கிறது.

உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.

முயன்று பார்

கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.

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

உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்

விவரங்கள்

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.

கோரிக்கை உடல்

பெயர்	வகை	தேவைப்படுகிறது	அது என்ன
`email`	`string`	ஆம்	—
`role`	`string`	ஆம்	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	இல்லை	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

பதில்

பெயர்	வகை	தேவைப்படுகிறது	அது என்ன
`id`	`string`	ஆம்	—
`org_id`	`string`	ஆம்	—
`org_name`	`string`	ஆம்	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	ஆம்	—
`role`	`string`	ஆம்	—
`site_grants`	`object[]`	ஆம்	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>`	ஆம்	—
`expires_at`	`string`	ஆம்	—
`accepted_at`	`string`	இல்லை	—
`created_at`	`string`	ஆம்	—

இந்த எண்ட்ஸ்பாயிண்ட் திரும்ப அனுப்பக்கூடிய பிழைகள்

401 · 403 · 422 · 429

POST /v1/members/invitations