뉴스레터 구독자를 등록하는 API입니다.
매뉴얼웍스 6.0.21 버전부터 지원합니다.
API 만들기
<도구 | API> 메뉴에서 “NEWSLETTER” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | NEWSLETTER_SUBSCRIBE |
문자열 | 구독자 이메일. 최대 320자 | 예 | dimdol@3rabbitz.com | |
name | 문자열 | 구독자 이름. 최대 100자 | 아니오 | 사용자 01 |
구독자를 등록하는 예제입니다.
{
"action": "NEWSLETTER_SUBSCRIBE",
"email": "support@3rabbitz.com",
"name": "쓰리래빗츠"
}다음을 참고합니다.
이메일은 앞뒤 공백을 없애고 소문자로 바꾸어 저장합니다. 따라서 대소문자만 다른 이메일은 같은 구독자로 처리합니다.
이미 등록한 이메일이면 구독자를 새로 만들지 않고 구독 상태로 되돌립니다. 같은 요청을 여러 번 보내도 결과는 같습니다.
name을 생략하면 이미 등록한 이름을 그대로 둡니다. 이름이 없는 구독자는 이메일을 이름으로 사용합니다.
이 API는 수신을 거부한 구독자도 다시 구독 상태로 만듭니다. 외부 시스템의 명단을 통째로 다시 보내면 수신을 거부한 사람에게 메일이 다시 발송될 수 있습니다. 상태를 바꾸지 않고 이름만 바꾸려면 NEWSLETTER_UPDATE를 사용합니다.
API 응답
NEWSLETTER_SUBSCRIBE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
subscriber | 구독자 객체 | 등록한 구독자 | 아니오 | |
errors | Error 객체 배열 | 예외 | 아니오 |
구독자 객체는 다음과 같습니다.
이름 | 유형 | 설명 | 예 |
|---|---|---|---|
id | 문자열 | 구독자 아이디 | 5b969d63e97cfec7 |
문자열 | 이메일 | support@3rabbitz.com | |
name | 문자열 | 이름 | 쓰리래빗츠 |
status | 문자열 | 구독 상태 | SUBSCRIBED | UNSUBSCRIBED |
createTime | 숫자 | 등록 시각. 밀리초 | 1785203527087 |
updateTime | 숫자 | 수정 시각. 밀리초 | 1785203527087 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
INVALID_EMAIL | 이메일 형식이 맞지 않을 때 |
INVALID_PARAMETER | 문자열의 길이가 형식에 맞지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{
"status": "success",
"subscriber": {
"id": "5b969d63e97cfec7",
"email": "support@3rabbitz.com",
"name": "쓰리래빗츠",
"status": "SUBSCRIBED",
"createTime": 1785203527087,
"updateTime": 1785203527087
}
}