SMS Consent: records a consent or opt-out transition with its proof-of-consent evidence.

POST /api/twilio/sms-consent deprecated

Requires: Twilio.SmsConsent.View, Twilio.SmsConsent.Manage, merchant scope.

Upserts the consent record for the phone number in the caller's merchant scope and appends the transition to its audit history. Requires the manage permission.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a RecordSmsConsentInput. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/twilio/sms-consent" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumber": ""
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "phoneNumber": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/twilio/sms-consent' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, MessagingApi } from '@winkpg/winkpg-api';

const api = new MessagingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.smsConsentRecordConsent({
  "phoneNumber": ""
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/twilio/sms-consent', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "phoneNumber": ""
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MessagingApi(config);
var body = JsonSerializer.Deserialize<RecordSmsConsentInput>("""
    {
      "phoneNumber": ""
    }
    """);

var result = await api.SmsConsentRecordConsentAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/twilio/sms-consent");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "phoneNumber": ""
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MessagingApi(client)
    body = winkpg_api.RecordSmsConsentInput.from_dict({
      "phoneNumber": ""
    })
    result = api.sms_consent_record_consent(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "phoneNumber": ""
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/twilio/sms-consent",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`phoneNumber` required	string	Recipient phone number in any common format; normalized to E.164 before persisting. nullable
`status` required	all of SmsConsentStatus	The status this transition sets (opted in or opted out).
`captureMethod` required	all of SmsConsentCaptureMethod	How the evidence for this transition was captured.
`evidenceText` required	string	Free-text proof-of-consent evidence (consent language shown, keyword received, operator note). nullablemax length 2000
`evidenceReference` required	string	Stable reference to the transition source (flow id, form URL, message SID, import batch). nullablemax length 512
`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

This request body has no documented fields.