Get a recipient tracking preference

Returns the organization-scoped tracking opt-out for a normalized recipient email. A missing preference reads as opted in and is not created.

GET
/v1/email/tracking/recipients

Returns the organization-scoped tracking opt-out for a normalized recipient email. A missing preference reads as opted in and is not created.

x-api-key<token>

In: header

Query Parameters

email*string
Match^[^\s@]+@[^\s@]+\.[^\s@]+$

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/email/tracking/recipients?email=string"
{  "email": "string",  "optedOut": true,  "trackingOptedOutAt": "string",  "createdAt": "string",  "updatedAt": "string"}

Related