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
^[^\s@]+@[^\s@]+\.[^\s@]+$EmailRecipientTrackingPreference
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.getRecipientTrackingPreference({ "email": "example"});Example Response
{ "email": "string", "optedOut": true, "trackingOptedOutAt": "string", "createdAt": "string", "updatedAt": "string"}Related documentation
Get receiving setup status
Reports sending verification, configured destinations (webhook endpoint, forwarding rules, and mailboxes), receiving enablement, and the inbound MX record.
Get a sender
Returns one sender owned by the authenticated organization. Other organizations' ids are reported as not found.