워크스페이스WorkspaceInvites

사용자 초대

제공된 이메일 주소로 워크스페이스 참여 초대 이메일을 보냅니다. 사용자에게 계정이 없으면 계정을 만들라는 안내가 표시됩니다. 사용자가 이 초대를 수락하면 시트 중 하나를 사용하여 워크스페이스와 구독에 사용자로 추가됩니다. 이 엔드포인트는 WORKSPACE_MEMBERS_INVITE 권한이 있는 워크스페이스 멤버만 호출할 수 있습니다. 사용자가 이미 워크스페이스에 있으면 400 오류가 반환됩니다.

헤더

xi-api-keystring선택 사항

요청

This endpoint expects an object.
emailstring필수

고객 이메일

seat_typeenum or null선택 사항

사용자의 시트 유형

허용된 값:
group_idslist of strings or null선택 사항

사용자의 그룹 ID

usage_limitinteger or null선택 사항>=0

초대 대상자의 월간 크레딧 사용 한도입니다. 맞춤 한도를 적용하지 않으려면 생략하거나 null로 설정하세요.

workspace_permissionstring or null선택 사항Deprecated

사용자의 워크스페이스 권한입니다. 이 항목은 더 이상 사용되지 않으므로 대신 seat_type을 사용하세요.

응답

성공 응답

statusstring

워크스페이스 초대 요청의 상태입니다. 요청에 성공하면 상태는 ‘ok’가 됩니다. 그렇지 않으면 상태 코드 500의 오류 메시지가 반환됩니다.

오류

422
Unprocessable Entity Error