action braze_query_list_of_unsubscribed_email_addresses {
label: "Query List of Unsubscribed Email Addresses"
description: "Use the /email/unsubscribes endpoint to return emails that have unsubscribed during the time period from `start_date` to `end_date`. You can use this endpoint to set up a bi-directional sync between Braze and other email systems or your own database.\n\n> You must provide either an email or a start_date and an end_date.
If your date range has more than `limit` number of unsubscribes, you will need to make multiple API calls, each time increasing the `offset` until a call returns either fewer than `limit` or zero results."
provider: braze
method: GET
path: "/email/unsubscribes"
encoding: json
input: {
type: "object"
properties: {
email: {
type: "string"
}
end_date: {
type: "string"
}
limit: {
type: "string"
}
offset: {
type: "string"
}
sort_direction: {
type: "string"
}
start_date: {
type: "string"
}
}
additionalProperties: false
}
output: {
type: "object"
additionalProperties: true
}
}