Chilkat Online Tools

autoit / Braze Endpoints / Query Hard Bounced Emails

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("start_date","2019-01-01")
$oQueryParams.UpdateString("end_date","2019-02-01")
$oQueryParams.UpdateInt("limit",100)
$oQueryParams.UpdateInt("offset",1)
$oQueryParams.UpdateString("email","example@braze.com")

; Adds the "Authorization: Bearer {{api_key}}" header.
$oHttp.AuthToken = "{{api_key}}"

Local $oResp = $oHttp.QuickRequestParams("GET","https://rest.iad-01.braze.com/email/hard_bounces",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($oResp.StatusCode & @CRLF)
ConsoleWrite($oResp.BodyStr & @CRLF)

Curl Command

curl -G -d "start_date=2019-01-01"
	-d "end_date=2019-02-01"
	-d "limit=100"
	-d "offset=1"
	-d "email=example%40braze.com"
	-H "Authorization: Bearer {{api_key}}"
https://rest.iad-01.braze.com/email/hard_bounces

Postman Collection Item JSON

{
  "name": "Query Hard Bounced Emails",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{api_key}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{instance_url}}/email/hard_bounces?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&email=example@braze.com",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "email",
        "hard_bounces"
      ],
      "query": [
        {
          "key": "start_date",
          "value": "2019-01-01",
          "description": "(Optional*) String in YYYY-MM-DD format \n\nStart date of the range to retrieve hard bounces, must be earlier than `end_date`. This is treated as midnight in UTC time by the API.\n\n*You must provide either an `email` or a `start_date`, and an `end_date`.\n"
        },
        {
          "key": "end_date",
          "value": "2019-02-01",
          "description": "(Optional*) String in YYYY-MM-DD format\n\nString in YYYY-MM-DD format. End date of the range to retrieve hard bounces. This is treated as midnight in UTC time by the API.\n\n*You must provide either an `email` or a `start_date`, and an `end_date`."
        },
        {
          "key": "limit",
          "value": "100",
          "description": "(Optional) Integer\n\nOptional field to limit the number of results returned. Defaults to 100, maximum is 500."
        },
        {
          "key": "offset",
          "value": "1",
          "description": "(Optional) Integer\n\nOptional beginning point in the list to retrieve from."
        },
        {
          "key": "email",
          "value": "example@braze.com",
          "description": "(Optional*) String\n\nIf provided, we will return whether or not the user has hard bounced.\n\n*You must provide either an `email` or a `start_date`, and an `end_date`."
        }
      ]
    },
    "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`.<br><br>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```"
  },
  "response": [
  ]
}