registerUnsubscribers

Classic/VPC 환경에서 이용 가능합니다.

광고 메일을 수신 거부할 메일 주소를 등록합니다. 등록된 메일 주소는 광고 메일이 수신 거부됩니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/unsubscribers

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`blockedReceivers`	List[String]	Required	등록할 수신자의 이메일 주소 목록

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://mail.apigw.fin-ntruss.com/api/v1/unsubscribers' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \ 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "blockedReceivers":[
    "xxx@naver.com",
    "xxx@daum.net"
  ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`count`	Integer	-	등록 요청받은 이메일 주소 중 수신 거부 목록에 등록된 메일 주소 개수
`requestCount`	Integer	-	등록 요청받은 이메일 주소 개수
`ignoreCount`	Integer	-	등록 요청받은 이메일 주소 중 등록되지 않은 메일 주소 개수

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "count": 100,
  "requestCount": 100,
  "ignoreCount": 0
}