Skip to content

수신 거부된 이메일 주소 목록 조회하기

get

/email/unsubscribes

이 엔드포인트를 사용하여 start_date에서 end_date까지의 기간 동안 수신 거부한 최신 이메일을 반환합니다. 전체 구독 상태 기록을 보려면 Currents를 사용하여 이 데이터를 추적하세요.

이 엔드포인트를 사용하여 Braze와 다른 이메일 시스템 또는 자체 데이터베이스 간의 양방향 동기화를 설정할 수 있습니다.

See me in Postman

필수 조건

이 엔드포인트를 사용하려면 email.unsubscribe 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 API 사용량 제한 설명서에 명시된 대로 기본 Braze 사용량 제한인 시간당 250,000건의 요청이 적용됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
start_date 선택 사항
(참고 참조)		 YYYY-MM-DD 형식의 문자열 수신 거부를 검색할 범위의 시작 날짜로, end_date보다 이전이어야 합니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
end_date 선택 사항
(참고 참조)		 YYYY-MM-DD 형식의 문자열 수신 거부를 검색할 범위의 종료 날짜입니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
limit 선택 사항 정수 반환되는 결과 수를 제한하는 선택적 필드입니다. 기본값은 100이며, 최대값은 500입니다.
offset 선택 사항 정수 검색을 시작할 목록의 시작점입니다(선택 사항).
sort_direction 선택 사항 문자열 asc 값을 전달하면 수신 거부를 가장 오래된 것부터 최신 순으로 정렬합니다. desc를 전달하면 최신에서 오래된 순으로 정렬합니다. sort_direction이 포함되지 않은 경우 기본 순서는 최신에서 오래된 순서입니다.
email 선택 사항
(참고 참조)		 문자열 제공된 경우 해당 사용자가 수신 거부했는지 여부를 반환합니다.

날짜 범위에 limit 이상의 수신 거부 건수가 있는 경우, 호출 결과가 limit보다 적거나 0이 될 때까지 매번 offset을 늘려가며 여러 번 API 호출을 수행해야 합니다.

요청 예시

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/unsubscribes?start_date=2020-01-01&end_date=2020-02-01&limit=1&offset=1&sort_direction=desc&[email protected]' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

응답

항목은 내림차순으로 나열됩니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

{
  "emails": [
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    },
    {
      "email": (string) an email that has been unsubscribed,
      "unsubscribed_at": (string) the time the email was unsubscribed in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!