Update a recipient tracking preference
Opts a normalized recipient email in or out of open and click tracking.
PATCH
Opts a normalized recipient email in or out of open and click tracking. Opt-out takes precedence over per-send overrides and organization defaults without changing suppression or send eligibility.
apiKeyheader
x-api-key<token>application/json- body
email*TrackingRecipientEmailMatch
^(?=[^@]{1,64}@)[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*@[^\s@/\\:#?%[\]\p{Cc}]+[.\u3002\uff0e\uff61][^\s@/\\:#?%[\]\p{Cc}]+$optedOut*booleanEmailRecipientTrackingPreference
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.updateRecipientTrackingPreference({
"email": "example",
"optedOut": true
});Example Response
{
"email": "string",
"optedOut": true,
"trackingOptedOutAt": "string",
"createdAt": "string",
"updatedAt": "string"
}