Ignore an email bounce

PATCH/reports/email-bounces/{bounce_id}

Marks an email bounce as ignored so the user's address can receive email from the account again. Requires the email_bounces.ignore permission.

The only accepted value is ignored: true. This change cannot be reverted through the API.

To make the update conditional, send an If-Match header built from the bounce's revision field, in the format W/"email_bounce:<bounce_id>:<revision>". If the bounce has changed since that revision, the update is rejected.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

bounce_id*string

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/reports/email-bounces/string" \  -H "Content-Type: application/json" \  -d '{    "ignored": true  }'
{  "data": {    "email": "string",    "id": "string",    "ignored": true,    "kind": "bounced",    "last_bounce_at": "2019-08-24T14:15:22Z",    "object": "email_bounce",    "revision": "string",    "user_id": "string"  }}