하드 바운스된 이메일 조회
get
/email/hard_bounces
이 엔드포인트를 사용하여 특정 기간 내에 이메일 메시지를 ‘하드 바운스’된 이메일 주소 목록을 가져올 수 있습니다.
필수 구성 요소
이 엔드포인트를 사용하려면 email.hard_bounces
권한이 있는 API 키가 필요합니다.
사용량 제한
요청 매개변수
매개변수 | 필수 | 데이터 유형 | 설명 |
---|---|---|---|
start_date |
선택 사항 (참고) |
YYYY-MM-DD 형식의 문자열 | 검색할 하드 바운스의 시작 날짜는 end_date 보다 이전이어야 합니다. API에 의해 이것은 UTC 시간으로 자정으로 처리됩니다. |
end_date |
선택 사항 (참고) |
YYYY-MM-DD 형식의 문자열 | 범위를 검색할 종료 날짜를 하드 바운스합니다. API에 의해 이것은 UTC 시간으로 자정으로 처리됩니다. |
limit |
선택 사항 | 정수 | 결과 수를 제한하는 선택적 필드입니다. 기본값은 100이며 최대값은 500입니다. |
offset |
선택 사항 | 정수 | 목록에서 검색할 선택적 시작 지점. |
email |
선택 사항 (참고) |
문자열 | 제공된 경우, 사용자가 하드 바운스했는지 여부를 반환합니다. 이메일 문자열이 올바르게 형식화되었는지 확인하십시오. |
note:
귀하는 start_date
및 end_date
또는 email
중 하나를 제공해야 합니다. start_date
, end_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&[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
18
19
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"emails": [
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
},
{
"email": (string) an email that has hard bounced,
"unsubscribed_at": (string) the time the email hard bounced in ISO 8601
}
],
"message": "success"
}
New Stuff!