WinkPG Docs
View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.

API reference Models

SmsConsentDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Read-only DTO for a merchant-scoped SMS consent / opt-out record, including its audit history.

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
id required string (uuid)
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.
phoneNumber required string Canonical E.164 phone number this record governs. 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.
tenantId required string (uuid) Tenant the record belongs to. 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.
merchantId required string (uuid) Merchant the record is scoped to. 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 Current consent state.
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.
OptedIn The recipient has expressly consented to receive SMS from this merchant. Sends are allowed.
OptedOut The recipient has revoked consent (STOP keyword, carrier unsubscribe, or an operator action). The send-time gate blocks every SMS to this number for this merchant until a re-opt-in is recorded.
captureMethod required SmsConsentCaptureMethod SmsConsentCaptureMethod How the most recent transition's evidence 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.
Unknown Capture method was not supplied. Treated as the least-authoritative evidence.
WebForm Recipient opted in through a public web form (e.g. a hosted checkout consent checkbox).
VirtualTerminal An operator captured consent while taking the payment in the Virtual Terminal.
HostedPaymentPage Consent was captured on a Hosted Payment Page flow.
Import The record was created from a bulk import of prior consent evidence.
ApiRequest Consent or opt-out was recorded through the API by an integrating system.
AdminEntry An administrator recorded the consent or opt-out manually.
CarrierBackfill Opt-out was back-filled from a carrier send-time signal (Twilio error 21610 on send). The platform learned of the revocation from the carrier rather than capturing it directly. Inbound STOP / START replies use InboundKeyword instead, which keeps a more precise evidence trail.
InboundKeyword Consent transition was captured from an inbound SMS keyword the recipient texted to the platform number (STOP / UNSUBSCRIBE / START / etc.), received on the Twilio inbound webhook. The inbound message SID is retained as the evidence reference.
statusChangedAt required string (date-time) When the current status was last set (UTC).
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 Proof-of-consent evidence for the current status. 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.
evidenceReference required string Stable reference for the current status's source. 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.
history required array of SmsConsentHistoryEntryDto array of SmsConsentHistoryEntryDto Append-only audit trail of every status transition, oldest first. 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.

Fields of each SmsConsentHistoryEntryDto:

Field Type Description
status required SmsConsentStatus SmsConsentStatus The status this transition moved the record to.
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.
OptedIn The recipient has expressly consented to receive SMS from this merchant. Sends are allowed.
OptedOut The recipient has revoked consent (STOP keyword, carrier unsubscribe, or an operator action). The send-time gate blocks every SMS to this number for this merchant until a re-opt-in is recorded.
captureMethod required SmsConsentCaptureMethod SmsConsentCaptureMethod How this transition's evidence 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.
Unknown Capture method was not supplied. Treated as the least-authoritative evidence.
WebForm Recipient opted in through a public web form (e.g. a hosted checkout consent checkbox).
VirtualTerminal An operator captured consent while taking the payment in the Virtual Terminal.
HostedPaymentPage Consent was captured on a Hosted Payment Page flow.
Import The record was created from a bulk import of prior consent evidence.
ApiRequest Consent or opt-out was recorded through the API by an integrating system.
AdminEntry An administrator recorded the consent or opt-out manually.
CarrierBackfill Opt-out was back-filled from a carrier send-time signal (Twilio error 21610 on send). The platform learned of the revocation from the carrier rather than capturing it directly. Inbound STOP / START replies use InboundKeyword instead, which keeps a more precise evidence trail.
InboundKeyword Consent transition was captured from an inbound SMS keyword the recipient texted to the platform number (STOP / UNSUBSCRIBE / START / etc.), received on the Twilio inbound webhook. The inbound message SID is retained as the evidence reference.
occurredAt required string (date-time) When the transition occurred (UTC).
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 Proof-of-consent evidence for this transition. 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.
evidenceReference required string Stable reference tying this transition to its source. 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 body has no documented fields.

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.