마케팅 동의 관리 API Endpoints
🔔 최신화 일자: 2026-06-16
nachocode 마케팅 수신 동의 관리 API를 활용하여 앱 유저의 마케팅 푸시 알림 동의 여부를 관리 할 수 있습니다.
이 문서에서는 API 사용법, 요청/응답 형식, 에러 케이스 등을 다룹니다.
공지
앱 유저 API는 비즈니스 멤버십 이상부터 사용 가능한 API로 nachocode 문의를 통해 기능 활성화가 가능합니다.
- 이메일 문의: support@nachocode.io
- 채팅 문의: https://nachocode.channel.io
마케팅 푸시
마케팅 푸시 전송 요청 시 저장된 유저의 마케팅 푸시 알림 수신 동의 여부에 따라 전송 여부가 결정됩니다.
[PUT] /api/app-user/v2/marketing
설명
- SDK의
setUserId()또는registerPushToken()을 통해 등록된 유저와 매핑된 모든 토큰의 광고성 푸시 알림 수신 동의 여부를 일괄 변경합니다. - 앱 환경이 아닌 환경에서 마케팅 수신 동의 여부 변경이 이뤄진 상황에 사용하기 적합합니다.
Request
-
Header
Parameter Type Required Description x-api-key string✔ API 키 x-secret-key string✔ Secret 키 -
Body
Parameter Type Required Constraints Description userId string | number✔ 동의 여부를 변경할 유저 ID state UserMarketingPreferenceState✔ 변경할 마케팅 동의 값
UserMarketingPreferenceState
declare type UserMarketingPreferenceState =| {marketing: true;marketingNight?: boolean;}| {marketing: false;marketingNight?: false;}| {marketingNight: boolean;};Parameter Type Required Constraints Description marketing boolean조건부 마케팅 푸시 수신 동의 여부 marketingNight boolean조건부 { marketing: false }일 때,{ marketingNight: true }불가야간 마케팅 푸시 수신 동의 여부 * 변경할 항목을 파라미터로 전달합니다. (ex:
{"marketingNight": true})
-
Example
curl -X POST "https://app.nachocode.io/api/app-user/v2/marketing" \-H "Content-Type: application/json" \-H "x-api-key: API_KEY_VALUE" \-H "x-secret-key: SECRET_KEY_VALUE" \-d '{"userId": "USER_ID_VALUE","state": {"marketing": true,"marketingNight": true}}'
Response
-
Success Response
-
Property
Properties Type Description status numberHTTP 응답 상태 코드 (200) response {marketing: boolean, marketingNight: boolean}갱신된 앱 유저 마케팅 수신 동의 여부 -
Example
{ "marketing": true, "marketingNight": true }
-
-
Error Response
-
에러코드
이 외 에러코드는 공통 에러코드 명세에서 확인 가능합니다.ErrorCode Status Code Message Description ERR-AB-ACS-31 403 This app is unable to handle user preference. 앱 유저 관리 기능 사용 불가 ERR-AB-ACS-32 410 User withdrawn. Please re-register. 이미 탈퇴 처리된 유저
Error Response
-
Property
Parameter Type Description statusCode number상태 코드 path string요청 경로 code string에러 코드 message string에러 메세지 -
Example
{"statusCode": 410,"path": "/api/app-user/marketing","code": "ERR-AB-ACS-32","message": "User withdrawn. Please re-register."}
공통 에러코드
샌드박스 혹은 운영환경에서 아래에 명세되지 않은 에러 코드를 수신받을 경우 나쵸코드로 문의해주세요.
| ErrorCode | StatusCode | Message | Description |
|---|---|---|---|
| ERR-AB-VAL-00 | 400 | Incorrect request. Server cannot understand request. | 요청 Body 데이터가 잘못된 경우 |
| ERR-AB-SGK-11 | 400 | Secret key not found. | Secret Key가 전달되지 않았을 경우 |
| ERR-AB-SGK-13 | 401 | Incorrect secret key. | 유효하지 않은 Secret Key |
| ERR-AB-KSY-11 | 400 | Required parameters missing. | API Key가 전달되지 않았을 경우 |
| ERR-AB-KSY-13 | 404 | Provided key information not found. Please check your key again. | 유효하지 않은 API Key |
| ERR-AB-AGK-11 | 400 | Api key not found. | Api Key가 전달되지 않았을 경우 |
| ERR-AB-AGK-12 | 400 | Invalid api key type. | 유효하지 않은 API Key |