Customer.io
v1.0.0
OpenAPI 3.1.0

Update a WhatsApp template

US region

Client Libraries
Shell Curl

Update a WhatsApp template

​

Update a WhatsApp template's name, folder, category, language, 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.

Meta reviews a template's content, category, and language. After you submit the template to Meta, you can't change those three fields unless Meta rejects the template. To change an approved template, create a new template and submit that one instead. You can change the name, folder, recipient, and sender at any time.

Renaming a template only changes the name your team sees in Design Studio. It doesn't rename the template you submitted to Meta.

Path Parameters
  • id
    Type: string Format: uuid
    required

    The UUID of the WhatsApp template.

Body
required
application/json

Send at least one of these properties.

  • category
    Type: string enum

    The new Meta template category.

    values
    • MARKETING
    • UTILITY
  • content
    Type: string

    The new template, written as WhatsApp markup. See the content field on Create a WhatsApp template for the format.

  • language
    Type: string
    min length:  
    1

    The new Meta language code, like en_US.

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

    A new friendly name for the template.

  • parent_folder_id
    Type: string | null Format: uuid

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

  • recipient
    Type: string
    min length:  
    1

    New liquid that resolves to the WhatsApp phone number of the person you're messaging, like {{customer.phone}}.

  • sender_id
    Type: integer | null Format: int64
    min:  
    1

    The ID of the WhatsApp sender identity to send the template from. Pass null to clear the sender.

Responses
  • 204

    WhatsApp template updated, no content returned

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

WhatsApp template updated, no content returned