Retrieve a marketing preference
Whether this person may be mailed, per channel, right now. Read it immediately before a send. BRANCH ON subscribed, NOT ON state. state carries the full vocabulary (subscribed, pending, unsubscribed, never) and only the first is mailable: pending is an opt-in that was never confirmed and never is silence rather than a recorded refusal. subscribed collapses the three non-mailable states into false, so the safe read is also the short one. erased OVERRIDES EVERY CHANNEL. It means this person’s data was wiped under an erasure request, so the address is gone and nothing may be sent whatever the last consent state said. email is null for a contact resolved from an anonymous id or a phone number, and for one that has been erased. Key your suppression records on contact_id and treat the address as a label. THERE IS NO COLLECTION HERE. A list would be the marketing database re-served through a second path; read /api/v1/marketing-contacts and filter on the consent fields it carries.
Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Path Parameters
Response
Success
