Skip to content

하드바운스된 이메일 조회

get

/email/hard_bounces

이 엔드포인트를 사용하여 특정 기간 내에 이메일 메시지가 “하드바운스”된 이메일 주소 목록을 가져올 수 있습니다.

See me in Postman

필수 조건

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

사용량 제한

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

요청 매개변수

매개변수 필수 데이터 유형 설명
start_date 선택 사항* YYYY-MM-DD 형식의 문자열 *start_date 또는 email 중 하나가 필요합니다. 하드바운스를 검색할 범위의 시작 날짜이며 end_date보다 이전이어야 합니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
end_date 필수 YYYY-MM-DD 형식의 문자열 하드바운스를 검색할 범위의 종료 날짜입니다. API에서 UTC 시간 기준 자정으로 처리됩니다.
limit 선택 사항 정수 반환되는 결과 수를 제한하는 선택적 필드입니다. 기본값은 100이며, 최대값은 500입니다.
offset 선택 사항 정수 검색을 시작할 목록의 시작점입니다(선택 사항).
email 선택 사항* 문자열 *start_date 또는 email 중 하나가 필요합니다. 제공된 경우 해당 사용자가 하드바운스되었는지 여부를 반환합니다. 이메일 문자열이 올바른 형식인지 확인하세요.

날짜 범위 내 하드바운스 수가 limit보다 많은 경우, 호출 결과가 limit보다 적거나 0이 될 때까지 매번 offset을 증가시키면서 여러 번 API를 호출해야 합니다. offset 및 limit 매개변수를 email과 함께 포함하면 빈 응답이 반환될 수 있습니다.

요청 예시

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1' \
--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 hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    },
    {
      "email": (string) an email that has hard bounced,
      "hard_bounced_at": (string) the time the email hard bounced in ISO 8601
    }
  ],
  "message": "success"
}
New Stuff!