RecordSmsConsentInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Records an SMS express-consent or opt-out transition with its proof-of-consent evidence.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
phoneNumber
required |
string | Recipient phone number in any common format; normalized to E.164 before persisting.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
status
required |
SmsConsentStatus SmsConsentStatus | The status this transition sets (opted in or opted out).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
captureMethod
required |
SmsConsentCaptureMethod SmsConsentCaptureMethod | How the evidence for this transition was captured.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
evidenceText
required |
string | Free-text proof-of-consent evidence (consent language shown, keyword received, operator note).
nullablemax length 2000
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
evidenceReference
required |
string | Stable reference to the transition source (flow id, form URL, message SID, import batch).
nullablemax length 512
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||||||||||||
merchantId
required |
string (uuid) | Merchant the consent is scoped to. Honoured only when the caller holds
`SmsConsent.ViewAllMerchants`; otherwise the caller's own merchant is used. Consent never transfers across merchants.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.