---
title: "PATCH /v1/sms/broadcasts/{id}/"
method: PATCH
path: "/v1/sms/broadcasts/{id}/"
tags: ["v1"]
---

# PATCH /v1/sms/broadcasts/{id}/

`PATCH /v1/sms/broadcasts/{id}/`

## Path parameters

- `id` integer, required

## Request body

- PatchedSMSBroadcast
  - `id` integer
  - `name` string
  - `message` string
  - `trigger` 0 | 1 | 2 | 3 | 4 — * `0` - Default * `1` - Birthday * `2` - Debt * `3` - Penalty * `4` - Congratulations
  - `schedule` string, nullable
  - `send_time` string, date-time, nullable
  - `enabled` boolean
  - `tenant` integer
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `recipients` SMSBroadcastRecipient[]
    - `phone` string, required
    - `client_id` integer, nullable

## Response `200`

- SMSBroadcast
  - `id` integer, required
  - `name` string, required
  - `message` string, required
  - `trigger` 0 | 1 | 2 | 3 | 4 — * `0` - Default * `1` - Birthday * `2` - Debt * `3` - Penalty * `4` - Congratulations
  - `schedule` string, nullable
  - `send_time` string, date-time, nullable
  - `enabled` boolean
  - `tenant` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `recipients` SMSBroadcastRecipient[], required
    - `phone` string, required
    - `client_id` integer, nullable

---

[API](https://skmtc.net/yume-cloud/apis/yume-api.md) · [All operations](https://skmtc.net/yume-cloud/apis/yume-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yume-cloud/yume-api/versions/90700f5abfcc/schema)