본문으로 건너뛰기

마케팅 동의 관리 API Endpoints

Thumbnail Image

🔔 최신화 일자: 2026-06-16


nachocode 마케팅 수신 동의 관리 API를 활용하여 앱 유저의 마케팅 푸시 알림 동의 여부를 관리 할 수 있습니다.

이 문서에서는 API 사용법, 요청/응답 형식, 에러 케이스 등을 다룹니다.

공지

앱 유저 API는 비즈니스 멤버십 이상부터 사용 가능한 API로 nachocode 문의를 통해 기능 활성화가 가능합니다.

마케팅 푸시

마케팅 푸시 전송 요청 시 저장된 유저의 마케팅 푸시 알림 수신 동의 여부에 따라 전송 여부가 결정됩니다.

[PUT] /api/app-user/v2/marketing

설명

  • SDK의 setUserId() 또는 registerPushToken()을 통해 등록된 유저와 매핑된 모든 토큰의 광고성 푸시 알림 수신 동의 여부를 일괄 변경합니다.
  • 앱 환경이 아닌 환경에서 마케팅 수신 동의 여부 변경이 이뤄진 상황에 사용하기 적합합니다.

Request

  • Header

    ParameterTypeRequiredDescription
    x-api-keystringAPI 키
    x-secret-keystringSecret 키
  • Body

    ParameterTypeRequiredConstraintsDescription
    userIdstring | number동의 여부를 변경할 유저 ID
    stateUserMarketingPreferenceState변경할 마케팅 동의 값

    UserMarketingPreferenceState

    declare type UserMarketingPreferenceState =
    | {
    marketing: true;
    marketingNight?: boolean;
    }
    | {
    marketing: false;
    marketingNight?: false;
    }
    | {
    marketingNight: boolean;
    };
    ParameterTypeRequiredConstraintsDescription
    marketingboolean조건부마케팅 푸시 수신 동의 여부
    marketingNightboolean조건부{ 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

      PropertiesTypeDescription
      statusnumberHTTP 응답 상태 코드 (200)
      response{marketing: boolean, marketingNight: boolean}갱신된 앱 유저 마케팅 수신 동의 여부
    • Example

      { "marketing": true, "marketingNight": true }

  • Error Response

    • Error Response

    • 에러코드

      이 외 에러코드는 공통 에러코드 명세에서 확인 가능합니다.
      ErrorCodeStatus CodeMessageDescription
      ERR-AB-ACS-31403This app is unable to handle user preference.앱 유저 관리 기능 사용 불가
      ERR-AB-ACS-32410User withdrawn. Please re-register.이미 탈퇴 처리된 유저

Error Response

  • Property

    ParameterTypeDescription
    statusCodenumber상태 코드
    pathstring요청 경로
    codestring에러 코드
    messagestring에러 메세지
  • Example

    {
    "statusCode": 410,
    "path": "/api/app-user/marketing",
    "code": "ERR-AB-ACS-32",
    "message": "User withdrawn. Please re-register."
    }




공통 에러코드

샌드박스 혹은 운영환경에서 아래에 명세되지 않은 에러 코드를 수신받을 경우 나쵸코드로 문의해주세요.

ErrorCodeStatusCodeMessageDescription
ERR-AB-VAL-00400Incorrect request. Server cannot understand request.요청 Body 데이터가 잘못된 경우
ERR-AB-SGK-11400Secret key not found.Secret Key가 전달되지 않았을 경우
ERR-AB-SGK-13401Incorrect secret key.유효하지 않은 Secret Key
ERR-AB-KSY-11400Required parameters missing.API Key가 전달되지 않았을 경우
ERR-AB-KSY-13404Provided key information not found. Please check your key again.유효하지 않은 API Key
ERR-AB-AGK-11400Api key not found.Api Key가 전달되지 않았을 경우
ERR-AB-AGK-12400Invalid api key type.유효하지 않은 API Key