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
^[^\s@]+@[^\s@]+\.[^\s@]+$optedOut*booleanEmailRecipientTrackingPreference
application/json- response
email*TrackingRecipientEmailMatch
^[^\s@]+@[^\s@]+\.[^\s@]+$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"}Related documentation
Update a forwarding rule
Updates an inbound email forwarding rule and returns its current summary. Use this endpoint to update a forwarding rule through the Samva email API.
Update email tracking defaults
Updates one or both organization email tracking defaults and returns the complete saved policy. Recipient opt-out still takes precedence.