Customer.io
v1.0.0
OpenAPI 3.1.0

Update an SMS

US region

Client Libraries
Shell Curl

Update an SMS

​

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.

Path Parameters
  • id
    Type: string Format: uuid
    required

    The UUID of the SMS.

Body
required
application/json

Send at least one of these properties.

  • content
    Type: string

    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.

  • name
    Type: string
    min length:  
    1
    max length:  
    191

    A new friendly name for the SMS.

  • parent_folder_id
    Type: string | null Format: uuid

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

  • recipient
    Type: string

    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_id
    Type: integer | null Format: int64

    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.

Responses
  • 204

    SMS updated, no content returned

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for put/v1/design_studio/sms/{id}
{
  "content": "<x-sms><x-sms-body>Hi {{customer.first_name}}, your order is out for delivery.</x-sms-body></x-sms>",
  "name": "Order shipped",
  "parent_folder_id": null,
  "recipient": "{{customer.phone}}",
  "sender_id": 2
}
No Body

SMS updated, no content returned