CUcustomer
SMS

Update an SMS

Changed on

Update an SMS's name, folder, content, recipient, or sender. You only need to send the fields you want to change; Customer.io keeps the current value of any field you leave out.

If the SMS is linked to a workflow, you need to publish your changes so your audience receives the latest content.

put/v1/design_studio/sms/{id}

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/design_studio/sms/{id}
  • Auth
    none declared

Path parameters

idstring uuid required

The UUID of the SMS.

Request body

namestring

A new friendly name for the SMS.

parent_folder_idstring uuid nullable

UUID of the folder you want to move the SMS into. Pass null to move the SMS to the root level.

contentstring

The new message, written as SMS markup. See the content field on Create an SMS for the format. If you pass an empty string, Customer.io clears the content, and you'll need to add content again before you can publish the SMS.

recipientstring

New liquid that resolves to the phone number of the person you're messaging, like {{customer.phone}}. If you pass an empty string, Customer.io clears the recipient and sends to {{customer.phone}}.

sender_idinteger nullable

The ID of the sender identity to send the SMS from. Pass null to clear the sender; you'll need to set one again before you can publish the SMS.

Example request

{
  "name": "Order shipped",
  "content": "<x-sms><x-sms-body>Hi {{customer.first_name}}, your order is out for delivery.</x-sms-body></x-sms>",
  "recipient": "{{customer.phone}}",
  "sender_id": 2
}

Response

SMS updated, no content returned

Changes