List consent setups

GET/api/v1/sms/consent-setups

GET /sms/consent-setups

curl -X GET 'https://www.unitpost.com/api/v1/sms/consent-setups' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms_consent_setup",
      "id": "id_123",
      "name": "Example",
      "type": "string",
      "source_url": "https://example.com",
      "is_public": false,
      "requires_authentication": false,
      "brand_name": "string",
      "message_purpose": "string",
      "frequency_disclosure": "string",
      "status": "queued",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Where and how people opt in to your texts: the form or page, the brand and purpose it discloses. A messaging program points at one with consent_setup_id. Archived ones are left out. Requires the sms:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields12 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`type`required	string	How people opt in, in the carriers' words (`DIGITAL_FORM`, `TEXT`, …): the values a program's `opt_in_type` takes.
`source_url`required	string \| null	—
`is_public`required	boolean	—
`requires_authentication`required	boolean	—
`brand_name`required	string \| null	—
`message_purpose`required	string \| null	—
`frequency_disclosure`required	string \| null	—
`status`required	string	—
`updated_at`required	string	—

200401403404422

List consent setups

List consent setups

Search docs and guides