Templates

Edit a template

PATCH

/{phone_number_id}/templates/{name}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.kirimdev.com/v1/106540352242922/templates/example"

  payload := strings.NewReader("{ \"components\": [ { \"type\": \"HEADER\", \"format\": \"TEXT\", \"text\": \"example\", \"example\": { \"header_text\": [ \"example\" ], \"header_handle\": [ \"example\" ], \"header_url\": [ \"https://example.com\" ], \"body_text\": [ [ \"example\" ] ] }, \"buttons\": [ { \"type\": \"URL\", \"text\": \"example\", \"url\": \"https://example.com\", \"phone_number\": \"example\", \"otp_type\": \"COPY_CODE\", \"autofill_text\": \"example\", \"supported_apps\": [ { \"package_name\": \"example\", \"signature_hash\": \"example\" } ], \"example\": [ \"example\" ] } ], \"add_security_recommendation\": true, \"code_expiration_minutes\": 1 } ] }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://api.kirimdev.com/v1/106540352242922/templates/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"components":[{"type":"HEADER","format":"TEXT","text":"example","example":{"header_text":["example"],"header_handle":["example"],"header_url":["https://example.com"],"body_text":[["example"]]},"buttons":[{"type":"URL","text":"example","url":"https://example.com","phone_number":"example","otp_type":"COPY_CODE","autofill_text":"example","supported_apps":[{"package_name":"example","signature_hash":"example"}],"example":["example"]}],"add_security_recommendation":true,"code_expiration_minutes":1}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use std::str::FromStr;
use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.kirimdev.com/v1/106540352242922/templates/example";

    let payload = json!({"components": (
            json!({
                "type": "HEADER",
                "format": "TEXT",
                "text": "example",
                "example": json!({
                    "header_text": ("example"),
                    "header_handle": ("example"),
                    "header_url": ("https://example.com"),
                    "body_text": (("example"))
                }),
                "buttons": (
                    json!({
                        "type": "URL",
                        "text": "example",
                        "url": "https://example.com",
                        "phone_number": "example",
                        "otp_type": "COPY_CODE",
                        "autofill_text": "example",
                        "supported_apps": (
                            json!({
                                "package_name": "example",
                                "signature_hash": "example"
                            })
                        ),
                        "example": ("example")
                    })
                ),
                "add_security_recommendation": true,
                "code_expiration_minutes": 1
            })
        )});

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request PATCH \
  --url https://api.kirimdev.com/v1/106540352242922/templates/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "components": [ { "type": "HEADER", "format": "TEXT", "text": "example", "example": { "header_text": [ "example" ], "header_handle": [ "example" ], "header_url": [ "https://example.com" ], "body_text": [ [ "example" ] ] }, "buttons": [ { "type": "URL", "text": "example", "url": "https://example.com", "phone_number": "example", "otp_type": "COPY_CODE", "autofill_text": "example", "supported_apps": [ { "package_name": "example", "signature_hash": "example" } ], "example": [ "example" ] } ], "add_security_recommendation": true, "code_expiration_minutes": 1 } ] }'

Edit an existing template’s content and re-submit it to Meta for review. The request body is components-only — send the FULL desired components array (Meta replaces all components at once; this is a replacement, not a partial patch). name, language, and category cannot change. Use ?language= to disambiguate when a name has multiple languages. Only templates already reviewed by Meta (approved / rejected) can be edited — a pending template returns 409 template_not_editable. On success the template re-enters Meta review, so the returned status is pending; poll GET /{phone_number_id}/templates/{name} for the eventual transition. Meta enforces its own edit rate limits (APPROVED: 10 edits / 30 days or 1 / 24h; rejected/paused unlimited) and surfaces them as 429 / 400.

Authorizations

bearerAuth

Parameters

Path Parameters

phone_number_id

required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

string

/^\d{6,20}$/

Example

106540352242922

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

name

required

string

>= 1 characters <= 512 characters

Query Parameters

language

string

>= 2 characters <= 15 characters

Request Body

application/json

object

components

required

Array<object>

>= 1 items

object

type

required

string

Allowed values: HEADER BODY FOOTER BUTTONS

format

string

Allowed values: TEXT IMAGE VIDEO DOCUMENT LOCATION

text

string

example

object

header_text

Array<string>

header_handle

Array<string>

header_url

Array<string>

body_text

Array<Array<string>>

buttons

Array<object>

object

type

required

string

Allowed values: URL PHONE_NUMBER QUICK_REPLY COPY_CODE OTP VOICE_CALL

text

string

>= 1 characters <= 25 characters

url

string format: uri

<= 2000 characters

phone_number

string

/^\+[1-9]\d{7,14}$/

otp_type

string

Allowed values: COPY_CODE ONE_TAP ZERO_TAP

autofill_text

string

supported_apps

Array<object>

object

package_name

required

string

signature_hash

required

string

example

Array<string>

add_security_recommendation

boolean

code_expiration_minutes

integer

>= 1 <= 60

Responses

200

Template edited (re-entered Meta review, status: pending)

application/json

object

data

required

object

required

string

object

required

string

Allowed values: template

name

required

string

language

required

string

status

required

string

Allowed values: pending approved rejected

category

required

Meta template category. null for templates synced before this field was recorded — a subsequent sync backfills it from Meta.

string | null

Allowed values: MARKETING UTILITY AUTHENTICATION

content

required

string

variables

required

Array<string>

components

whatsapp_account

required

object

phone_number

required

string | null

phone_number_id

required

Meta business_phone_number_id — use as the {phone_number_id} path segment in /v1/{phone_number_id}/... endpoints.

string | null

customer

required

End-customer (multi-tenant platform mode) that owns this account. NULL for direct-org accounts.

object

required

string

name

required

string

provider_template_id

required

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

request_id

required

string

Example

{
  "data": {
    "id": "tmpl_01HXYZABCDEFGHJKMNPQRSTVWX",
    "object": "template",
    "status": "pending",
    "category": "MARKETING",
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    }
  }
}

400

Validation failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Authentication failure

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

404

Resource not found

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

409

Conflict (e.g. template already exists, webhook subscription disabled, setup link inactive)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

422

Semantic failure (e.g. idempotency key reuse, pre-send compliance guard, media not found)

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Rate limit exceeded

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Internal server error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

502

Upstream WhatsApp error

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error api_error

code

required

string

message

required

string

param

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}