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
Returns the organization-scoped tracking opt-out for a normalized recipient email. A missing preference reads as opted in and is not created.
apiKeyheader
x-api-key<token>email*stringMatch
^(?=[^@]{1,64}@)[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@[^\s@/\\:#?%[\]\p{Cc}]+[.\u3002\uff0e\uff61][^\s@/\\:#?%[\]\p{Cc}]+$EmailRecipientTrackingPreference
application/json- response
email*TrackingRecipientEmailMatch
^(?=[^@]{1,64}@)[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@[^\s@/\\:#?%[\]\p{Cc}]+[.\u3002\uff0e\uff61][^\s@/\\:#?%[\]\p{Cc}]+$optedOut*booleantrackingOptedOutAt*string|nullcreatedAt*string|nullupdatedAt*string|nullimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.email.getRecipientTrackingPreference({
"email": "example"
});Example Response
{
"email": "string",
"optedOut": true,
"trackingOptedOutAt": "string",
"createdAt": "string",
"updatedAt": "string"
}