뉴스레터 구독자의 이름을 바꾸는 API입니다.
매뉴얼웍스 6.0.21 버전부터 지원합니다.
API 만들기
<도구 | API> 메뉴에서 “NEWSLETTER” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | NEWSLETTER_UPDATE |
문자열 | 바꿀 구독자를 찾는 이메일. 최대 320자 | 예 | dimdol@3rabbitz.com | |
name | 문자열 | 새 이름. 최대 100자 | 예 | 사용자 01 |
구독자의 이름을 바꾸는 예제입니다.
{
"action": "NEWSLETTER_UPDATE",
"email": "support@3rabbitz.com",
"name": "쓰리래빗츠"
}다음을 참고합니다.
이메일로 구독자를 찾습니다. 등록하지 않은 이메일이면 구독자를 새로 만들지 않고 예외를 반환합니다.
이메일은 구독자를 구분하는 값이므로 이 API로 바꿀 수 없습니다.
구독 상태는 바꾸지 않습니다. 수신을 거부한 구독자의 이름을 바꾸어도 거부 상태를 그대로 둡니다. 구독 상태를 바꾸려면 뉴스레터 구독자 등록이나 뉴스레터 구독 취소를 사용합니다.
API 응답
NEWSLETTER_UPDATE 응답
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": "SUBSCRIBED",
"createTime": 1785203527087,
"updateTime": 1785203598120
}
}