Record contact consent
Records the contact's consent on one channel at one of its addresses and returns the contact.
PUT
Records the contact's consent on one channel at one of its addresses and returns the contact. opted_out stops every send on that channel to that address until the contact opts back in; opted_in is what channels that require opt-in check for. source and capturedAt say where and when the contact decided; proof keeps your evidence. A decision captured before the recorded one is ignored. A change publishes contact.consent_changed.
apiKeyheader
x-api-key<token>id*stringMatch
^contact_[0-9a-hjkmnp-tv-z]{16,24}$identityId*stringMatch
^cident_[0-9a-hjkmnp-tv-z]{16,24}$channel*stringValue in
"sms""whatsapp""email"application/json- body
status*stringValue in
"opted_in""opted_out"source*stringWhere the consent was captured, such as a form URL or a checkout step.
Length
1 <= length <= 200capturedAt*stringproof?|nullContact
application/json- response
id*ContactIdMatch
^contact_[0-9a-hjkmnp-tv-z]{16,24}$namespaceId*|nullname*stringdisplayName*string|nullavatar*string|nullstatus*stringValue in
"active""paused""blocked""archived"statusReason*string|nullexternalId*string|nullidentities*array<>profile*|nullpreferences*|nulltags*array<string>metadata*|nullimportProvenance*|nullcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.contacts.setConsent({ "id": "example", "identityId": "example", "channel": "sms", "status": "opted_in", "source": "example", "capturedAt": "example"});Example Response
{ "id": "string", "namespaceId": "string", "name": "string", "displayName": "string", "avatar": "string", "status": "active", "statusReason": "string", "externalId": "string", "identities": [ { "id": "string", "type": "email", "identifier": "string", "verified": true, "channels": [ { "channel": "sms", "reachability": "unknown", "consent": { "status": "opted_in", "source": "string", "capturedAt": "string", "proof": { "property1": "string", "property2": "string" } } } ] } ], "profile": { "firstName": "string", "lastName": "string", "company": "string", "jobTitle": "string", "location": { "country": "string", "state": "string", "city": "string", "timezone": "string" }, "customFields": { "property1": "string", "property2": "string" }, "source": "api" }, "preferences": { "preferredChannels": [ "sms" ], "language": "string", "timezone": "string", "notifications": { "email": true, "sms": true, "whatsapp": true, "quiet_hours": { "start": "string", "end": "string" } } }, "tags": [ "string" ], "metadata": { "property1": "string", "property2": "string" }, "importProvenance": { "first": { "jobId": "string", "topicId": "string", "preset": "beehiiv", "importedAt": "string", "summary": { "signupAt": { "value": "string", "kind": "time" }, "sources": [ "string" ], "omittedSources": 0 }, "evidence": [ { "file": "string", "row": -9007199254740991, "declared": { "kind": "status_column" }, "suppressionFree": true, "sourceStatus": "string", "signupAt": "string", "source": "string" } ] }, "latest": { "jobId": "string", "topicId": "string", "preset": "beehiiv", "importedAt": "string", "summary": { "signupAt": { "value": "string", "kind": "time" }, "sources": [ "string" ], "omittedSources": 0 }, "evidence": [ { "file": "string", "row": -9007199254740991, "declared": { "kind": "status_column" }, "suppressionFree": true, "sourceStatus": "string", "signupAt": "string", "source": "string" } ] } }, "createdAt": "string", "updatedAt": "string"}