---
title: "Read Sms Opt In"
method: GET
path: "/setup/sms-opt-in"
tags: ["authenticated", "setup"]
---

# Read Sms Opt In

`GET /setup/sms-opt-in`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/setup/sms-opt-in`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- SmsOptInPublic: The opt-in surface of the compliance record, for the organization's own admins. Separate from ``MessagingComplianceConfigPublic``, which withholds the evidence URLs from staff reads; the customer who supplied them may see them back.
  - `method` string, nullable
  - `flow_description` string, nullable
  - `additional_consent_copy` string, nullable
  - `consent_language` string, nullable
  - `required_disclosure` string, required
  - `evidence_urls` string[]
  - `message_frequency` string, nullable
  - `help_message` string, nullable
  - `stop_message` string, nullable
  - `terms_url` string, nullable
  - `privacy_url` string, nullable
  - `ready_for_submission` boolean, required
  - `blockers` string[]

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/86e2c2bd93af?raw)