그룹을 삭제하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “GROUP” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 요청

POST 형식으로 요청해야 합니다.

JSON 요청 형식입니다.

이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	GROUP_REMOVE
groupId	문자열	삭제할 그룹 아이디	예	group01

예제는 다음과 같습니다.

{
    "action": "GROUP_REMOVE",
    "groupId": "group01"
}

JSON 형식의 응답은 다음과 같습니다.

`GROUP_REMOVE` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

예외 항목은 다음과 같습니다.

예외	설명
GROUP_NOT_EXIST	삭제할 그룹이 존재하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제입니다.

{
	"status": "success"
}