List messaging programs

GET/api/v1/sms/messaging-programs

GET /sms/messaging-programs

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

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "name": "Example",
      "description": "string",
      "message_type": "transactional",
      "canonical_purpose": "string",
      "frequency_disclosure": "string",
      "opt_in_type": "string",
      "opt_in_workflow": "string",
      "opt_in_confirmation": "string",
      "help_message": "string",
      "stop_message": "string",
      "terms_url": "https://example.com",
      "privacy_url": "https://example.com",
      "monthly_volume": "string",
      "sample_messages": [
        "string"
      ],
      "embedded_links": false,
      "embedded_link_sample": "string",
      "embedded_phones": false,
      "age_gated": false,
      "provider_overrides": {
        "toll_free": {
          "use_case_category": "string"
        },
        "ten_dlc": {
          "use_case": "string",
          "sub_use_cases": [
            "string"
          ]
        }
      },
      "recipe_id": "recipe_123",
      "consent_setup_id": "consent_setup_123",
      "object": "sms_messaging_program",
      "id": "id_123",
      "recipe_version": 0,
      "revision": 0,
      "readiness": {
        "ready": false,
        "missing": [
          "string"
        ]
      },
      "archived_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Your messaging programs: what a sender registration says your texts are for, how people opt in, the help and stop replies and sample messages. Registrations copy a program when submitted; writing a program never changes one. archived=true includes archived ones. Requires the sms:read capability.

Parameters4 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).
`archived`	string · query	`true` includes archived programs.

Response · 200 fields29 fields

Field	Type	Description
`name`required	string	—
`description`	string \| null	—
`message_type`required	enumtransactional \| marketing	—
`canonical_purpose`	string \| null	—
`frequency_disclosure`	string \| null	—
`opt_in_type`	string \| null	—
`opt_in_workflow`	string \| null	—
`opt_in_confirmation`	string \| null	—
`help_message`	string \| null	—
`stop_message`	string \| null	—
`terms_url`	string \| null	—
`privacy_url`	string \| null	—
`monthly_volume`	string \| null	—
`sample_messages`required	string[]	—
`embedded_links`required	boolean	—
`embedded_link_sample`	string \| null	—
`embedded_phones`required	boolean	—
`age_gated`required	boolean	—
`provider_overrides`	object \| null	—
`recipe_id`required	string \| null	—
`consent_setup_id`	string \| null	A consent setup (`cset_…`) this workspace has.
`object`required	string	—
`id`required	string	—
`recipe_version`required	integer \| null	—
`revision`required	integer	Moves on a material change; registrations keep the revision they copied.
`readiness`required	object	Whether the program has what a registration needs; `missing` names the fields still to fill (the wizard's own check).
`archived_at`required	string \| null	—
`created_at`required	string	—
`updated_at`required	string	—

200401403404422

List messaging programs

List messaging programs

Search docs and guides