Get a contact's SMS consent
GET/api/v1/contacts/{id}/sms-consent
GET /contacts/{id}/sms-consent
curl -X GET 'https://www.unitpost.com/api/v1/contacts/con_123/sms-consent' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0'Response · 200
{
"object": "sms_consent",
"phone": "string",
"country": "string",
"status": "queued",
"marketing_eligible": false,
"consented_at": "2026-01-01T00:00:00.000Z",
"consent_source": "string",
"consent_purpose": "string",
"history": [
{
"id": "id_123",
"action": "string",
"source": "string",
"purpose": "string",
"occurred_at": "2026-01-01T00:00:00.000Z",
"evidence_url": "https://example.com",
"disclosure_version": "string"
}
]
}Read a contact's current SMS consent state and the full immutable consent history — what was agreed to, when, and from which source. Use this to answer a carrier or regulator asking you to prove a recipient opted in, without contacting support. marketing_eligible is the field that decides whether marketing SMS to this contact will be accepted. Requires the contacts:read capability.
Parameters1 field
| Field | Type | Description |
|---|---|---|
idrequired | string · path | — |
Response · 200 fields9 fields
| Field | Type | Description |
|---|---|---|
objectrequired | string | — |
phonerequired | object | — |
country | object | — |
statusrequired | string | — |
marketing_eligible | boolean | — |
consented_at | object | — |
consent_source | object | — |
consent_purpose | object | — |
historyrequired | object[] | — |
200401404