Update a recipient tracking preference

Opts a normalized recipient email in or out of open and click tracking.

PATCH
/v1/email/tracking/recipients

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.

Authorization

apiKey
headerx-api-key<token>

Request Body

application/json
  1. body
email*TrackingRecipientEmail
Match^[^\s@]+@[^\s@]+\.[^\s@]+$
optedOut*boolean

Response Body

EmailRecipientTrackingPreference

application/json
  1. response
email*TrackingRecipientEmail
Match^[^\s@]+@[^\s@]+\.[^\s@]+$
optedOut*boolean
trackingOptedOutAt*string|null
createdAt*string|null
updatedAt*string|null
Example Request
import { 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