Peach

Update template

PATCH

/api/v1/whats_app_templates/{id}

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

string

required

Template ID

Example:

wt_template_id_1

Body Params application/json

whats_app_template

object

required

template_name

string

required

folder

string

required

category

string

required

components_attributes

array [object {2}]

required

Example

{
  "whats_app_template": {
    "template_name": "Updated Template Name",
    "folder": "New Folder",
    "category": "MARKETING",
    "components_attributes": [
      {
        "id": "component_id_1",
        "value": "Updated body text with {{variable | example: 'value'}}."
      },
      {
        "id": "component_id_2",
        "value": "Updated header text"
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v1/whats_app_templates/wt_template_id_1' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
  "whats_app_template": {
    "template_name": "Updated Template Name",
    "folder": "New Folder",
    "category": "MARKETING",
    "components_attributes": [
      {
        "id": "component_id_1",
        "value": "Updated body text with {{variable | example: '\''value'\''}}."
      },
      {
        "id": "component_id_2",
        "value": "Updated header text"
      }
    ]
  }
}'

Responses

🟢200Success

application/json

Body

string

required

template_name

string

required

language

string

required

category

string

required

status

string

required

whats_app_business_account_id

integer

required

components

array [object {5}]

required

string

optional

component_type

string

optional

data_type

string

optional

value

string

optional

index

integer

optional

Example

{
  "id": "template_prefix_id_1",
  "template_name": "Template to Archive",
  "language": "en",
  "category": "MARKETING",
  "status": "disabled",
  "whats_app_business_account_id": 123,
  "components": [
    {
      "id": "component_id_1",
      "component_type": "body",
      "data_type": "text",
      "value": "This template is now archived.",
      "index": 0
    }
  ]
}

Modified at 2025-06-10 07:11:05

Create a template

Archive template