뉴스레터 구독을 취소하는 API입니다.
매뉴얼웍스 6.0.21 버전부터 지원합니다.
API 만들기
<도구 | API> 메뉴에서 “NEWSLETTER” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | NEWSLETTER_UNSUBSCRIBE |
문자열 | 구독을 취소할 구독자의 이메일. 최대 320자 | 예 | dimdol@3rabbitz.com |
구독을 취소하는 예제입니다.
{
"action": "NEWSLETTER_UNSUBSCRIBE",
"email": "support@3rabbitz.com"
}다음을 참고합니다.
구독자를 지우지 않고 구독 상태만
UNSUBSCRIBED로 바꿉니다. 따라서 구독을 취소한 기록이 남습니다.이미 구독을 취소한 구독자에게 다시 요청해도 예외가 발생하지 않습니다. 같은 요청을 여러 번 보내도 결과는 같습니다.
구독을 취소한 구독자를 다시 구독 상태로 만들려면 뉴스레터 구독자 등록을 사용합니다.
구독자를 완전히 지우는 API는 제공하지 않습니다. 구독자를 지우면 구독을 취소한 기록도 함께 사라져서, 외부 시스템의 명단을 다시 보낼 때 수신을 거부한 사람이 구독자로 되살아나기 때문입니다. 구독자를 완전히 지워야 할 때는 관리 화면에서 지웁니다.
API 응답
NEWSLETTER_UNSUBSCRIBE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
subscriber | 구독자 객체 | 구독을 취소한 구독자 | 아니오 | |
errors | Error 객체 배열 | 예외 | 아니오 |
응답에 포함하는 구독자 객체는 구독자 객체를 참고합니다.
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
INVALID_EMAIL | 이메일 형식이 맞지 않을 때 |
INVALID_PARAMETER | 문자열의 길이가 형식에 맞지 않을 때 |
NEWSLETTER_SUBSCRIBER_NOT_EXIST | 해당 이메일의 구독자가 없을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{
"status": "success",
"subscriber": {
"id": "5b969d63e97cfec7",
"email": "support@3rabbitz.com",
"name": "쓰리래빗츠",
"status": "UNSUBSCRIBED",
"createTime": 1785203527087,
"updateTime": 1785203641955
}
}