action braze_query_hard_bounced_emails {
label: "Query Hard Bounced Emails"
description: "This endpoint allows you to pull a list of email addresses that have “hard bounced” your email messages within a certain time frame.\n\n> You must provide an `end_date`, as well as either an `email` or a `start_date`.
If your date range has more than `limit` number of hard bounces, you will need to make multiple API calls, each time increasing the `offset` until a call returns either fewer than `limit` or zero results.\n\n## Response\n\nEntries are listed in descending order.\n\n```json\nContent-Type: application/json\nAuthorization: Bearer YOUR-REST-API-KEY\n{\n \"emails\": [\n {\n \"email\": \"example1@braze.com\",\n \"hard_bounced_at\": \"2016-08-25 15:24:32 +0000\"\n },\n {\n \"email\": \"example2@braze.com\",\n \"hard_bounced_at\": \"2016-08-24 17:41:58 +0000\"\n },\n {\n \"email\": \"example3@braze.com\",\n \"hard_bounced_at\": \"2016-08-24 12:01:13 +0000\"\n }\n ],\n \"message\": \"success\"\n}\n```"
provider: braze
method: GET
path: "/email/hard_bounces"
encoding: json
input: {
type: "object"
properties: {
email: {
type: "string"
}
end_date: {
type: "string"
}
limit: {
type: "string"
}
offset: {
type: "string"
}
start_date: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
additionalProperties: true
}
}