콘텐츠로 이동

멤버 초대¶

POST /api/v1/workspace/member/batch_invitation

개요¶

하나 또는 여러 멤버 초대

Body 요청 파라미터¶

파라미터명	유형	필수	설명
to	array	Y	초대받는 사람 목록 예시: ['xxx@guance.com', 'xxx@guance.com'] 비어 있음 허용: True
roleUUIDs	array	Y	초대받는 사람 역할 uuid 목록 예시: ['wsAdmin'] 비어 있음 허용: False
method	string	Y	초대 방식 예시: None 비어 있음 허용: False 선택 가능 값: ['email']

파라미터 추가 설명¶

roleUUIDs 설명

역할	설명
wsAdmin	관리자 역할, owner / wsAdmin만 초대 가능
general	표준 멤버 역할
readOnly	읽기 전용 역할
role_xxx	사용자 정의 역할

초대를 통해 owner 역할을 설정할 수 없습니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/workspace/member/batch_invitation' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"to": ["xxx@guance.com"], "method": "email", "roleUUIDs": ["general"]}' \
--compressed

응답¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}