---
title: "Update an SMS campaign"
method: PATCH
path: "/3.0/sms-campaigns/{sms_campaign_id}"
tags: ["sms-campaigns"]
---

# Update an SMS campaign

`PATCH /3.0/sms-campaigns/{sms_campaign_id}`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/sms-campaigns/{sms_campaign_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/sms-campaigns/:sms_campaign_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update an SMS campaign.

## Path parameters

- `sms_campaign_id` string, required

## Request body

- object: The settings for updating an SMS campaign.
  - `name` string: The name of the campaign.
  - `folder_id` string: The ID of the folder to place this campaign in.
  - `segments` integer[]: The segment IDs to target for this campaign.
  - `excluded_segments` integer[]: The segment IDs to exclude from this campaign.

## Response `200`

- object: A single SMS campaign.
  - `id` string: A string that uniquely identifies this campaign.
  - `web_id` string: The ID used in the Mailchimp web application.
  - `name` string: The name of the campaign.
  - `status` string: The current status of the campaign.
  - `channel` string: The channel for this campaign (sms or whatsapp).
  - `list_id` integer: The numeric ID of the list associated with this campaign.
  - `recipient_count` integer: The number of recipients for this campaign.
  - `create_time` string, date-time: The date and time the campaign was created.
  - `send_time` string, date-time: The date and time the campaign is scheduled to send.
  - `updated_at` string, date-time: The date and time the campaign was last updated.
  - `expire_time` string, date-time: The date and time the campaign will stop sending in ISO 8601 format.
  - `is_send_now` boolean: Whether the campaign is configured to send immediately.
  - `folder_id` string: The ID of the folder this campaign is in.
  - `segments` integer[]: The segment IDs used to target recipients for this campaign.
  - `excluded_segments` integer[]: The segment IDs excluded from receiving this campaign.
  - `campaign_segments` object: The campaign's targeting with each segment's type. `regular` covers tags and saved segments; `advanced` covers advanced segments. Segment IDs alone cannot distinguish the two. Returned when you get or update a single campaign. Omitted from list and create responses, for campaigns that send to the whole audience, and for older campaigns saved before segment types were recorded. Read-only: `PATCH` takes `segments` and `excluded_segments`, keeps the type of IDs already on the campaign, and adds new IDs (and IDs on older campaigns) as `regular`.
    - `inclusions` object[]: The segments this campaign sends to.
      - `id` integer: The segment ID.
      - `type` string: `regular` or `advanced`.
    - `exclusions` object[]: The segments excluded from this campaign.
      - `id` integer: The segment ID.
      - `type` string: `regular` or `advanced`.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

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