members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

모든 members 엔드포인트

모든 개발자 문서 →

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 members.invite 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

조직 ID가 들어가는 위치

이 엔드포인트는 JSON 본문의 필드로 org_id을(를) 받습니다.

조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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…
`status`	`string<pending, accepted, revoked>`	예	—
`expires_at`	`string`	예	—
`accepted_at`	`string`	아니요	—
`created_at`	`string`	예	—

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 422 · 429