복사성공!
1
[DELETE] {{hostName}}/api/v1/invitation/{invitationId}
초대 진행중인 Biz 사용자의 초대 절차를 취소합니다.
초대 취소 요청이 수락되어도, 이미 초대 완료된 Biz 사용자에 대해서는 취소가 불가능합니다.
- Biz Service 초대장 발송 시에는, Biz Kit 기본 정보 필수값이 미리 입력되어 있어야 합니다. Biz Kit 기본 정보 입력 를 참고해주세요.
1. URL
2. Request
2.1 Body
body
복사성공!
1
2
3
4
5
6
7
{
"users": [
{
"email": "XXX"
}
]
}
2.2 설명
| 이름 | 유형 | 속성 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| Publisher-Token | Header | string | Y | 퍼블리셔가 보유한 토큰 | |
| invitationId | parameter | int | Y | 초대 사유 | |
| users | body | array of object | 초대한 사용자의 정보 | ||
| users[].email | body | string | 350 | Y | 취소대상자의 이메일 만일 값이 비워져 있을 경우 초대 요청 내 모든 사용자에 대한 초대 취소가 이뤄진다. 대상자를 지정했어도 이미 사용자가 초대를 수락한 경우 취소처리되지 않는다. |
3. Response
3.1 HTTP Status
| HTTP Status | errorCode | 설명 |
|---|---|---|
| 200 | 정상적으로 초대 취소 요청이 수락된 경우의 응답 | |
| 403 | 퍼블리셔 API Token이 유효하지 않거나, 유효하지 않은 자원에 접근할 경우 리턴 | |
| 406 | 초대 요청 사용자가 초대 행위를 이미 진행했거나, 진행중으로 취소가 불가능한 경우의 응답 | |
| 404 | 대상되는 초대 요청 사용자가 없음 |
3.2 Body
복사성공!
1
2
3
4
5
6
7
{
"users": [
{
"email": "XXX"
}
]
}
3.3 설명
| 이름 | 유형 | 속성 | 필수 | 설명 |
|---|---|---|---|---|
| users | body | array of object | 취소 요청에 의해 정상적으로 초대가 취소된 사용자 목록 | |
| users[].email | body | string | Y | 초대가 취소된 사용자의 이메일 |