Update a messaging program

PATCH/api/v1/sms/messaging-programs/{id}

PATCH /sms/messaging-programs/{id}

curl -X PATCH 'https://www.unitpost.com/api/v1/sms/messaging-programs/123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "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"
}

Edit a program: only the fields sent change, null clears one, and the result must still pass the carriers' rules. revision moves on a material change; registrations keep the copy they made. An archived program is a 409: duplicate it to keep editing. Requires the sms:manage capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Request body21 fields

Field	Type	Description
`name`	string	—
`description`	string \| null	—
`message_type`	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`	string[]	—
`embedded_links`	boolean	—
`embedded_link_sample`	string \| null	—
`embedded_phones`	boolean	—
`age_gated`	boolean	—
`provider_overrides`	object \| null	—
`recipe_id`	enumACCOUNT_NOTIFICATIONS \| SECURITY_ALERTS \| ONE_TIME_PASSCODES \| ORDER_UPDATES \| APPOINTMENT_REMINDERS \| CUSTOMER_SUPPORT \| MARKETING_PROMOTIONS \| OTHER_CUSTOM	The compliance recipe the program follows; its version is the recipe's current one. Left out, it's derived from `canonical_purpose`.
`consent_setup_id`	string \| null	A consent setup (`cset_…`) this workspace has.

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	—

200400401403404409422

Update a messaging program

Update a messaging program

Search docs and guides