WhatsApp · WhatsApp

Update template

Updates a template. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/whatsapp/templates/{templateName}

updateWhatsAppTemplate

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`templateName`required	string

Request body

application/json, required

accountIdstringrequired
languagestring
componentsarray of object
At least 1 item.
One of:
Whats App Header Component (4 fields)
- typestringrequired
  One of header.
- formatstringrequired
  One of text, image, video, gif, document, location.
- textstring
- exampleobject
  3 child fields
  header_textarray of string
  header_text_named_paramsarray of object
  2 child fields
  param_namestringrequired
  Matches ^[a-z0-9_]+$.
  examplestringrequired
  header_handlearray of string (URL)
  At least 1 item. Up to 1 items.
Whats App Body Component (4 fields)
- typestringrequired
  One of body.
- textstringrequired
- add_security_recommendationboolean
- exampleobject
  2 child fields
  body_textarray of array of string
  body_text_named_paramsarray of object
  2 child fields
  param_namestringrequired
  Matches ^[a-z0-9_]+$.
  examplestringrequired
Whats App Footer Component (3 fields)
- typestringrequired
  One of footer.
- textstring
- code_expiration_minutesinteger
  At least 1.
Whats App Buttons Component (2 fields)
- typestringrequired
  One of buttons.
- buttonsarray of objectrequired
  At least 1 item.
  14 child fields
  typestringrequired
  One of quick_reply, url, phone_number, otp, copy_code, flow, mpm, catalog.
  textstring
  urlstring (URL)
  exampleany
  phone_numberstring
  otp_typestring
  One of copy_code, one_tap, zero_tap.
  autofill_textstring
  package_namestring
  signature_hashstring
  flow_idstring
  flow_namestring
  flow_jsonstring
  flow_actionstring
  navigate_screenstring
Whats App Carousel Component (2 fields)
- typestringrequired
  One of carousel.
- cardsarray of objectrequired
  At least 2 items. Up to 10 items.
  1 child field
  componentsarray of objectrequired
  At least 1 item.
  One of:
  Whats App Header Component (4 fields)
  typestringrequired
  One of header.
  formatstringrequired
  One of text, image, video, gif, document, location.
  textstring
  exampleobject
  3 child fields
  header_textarray of string
  header_text_named_paramsarray of object
  2 child fields
  param_namestringrequired
  Matches ^[a-z0-9_]+$.
  examplestringrequired
  header_handlearray of string (URL)
  At least 1 item. Up to 1 items.
  Whats App Body Component (4 fields)
  typestringrequired
  One of body.
  textstringrequired
  add_security_recommendationboolean
  exampleobject
  2 child fields
  body_textarray of array of string
  body_text_named_paramsarray of object
  2 child fields
  param_namestringrequired
  Matches ^[a-z0-9_]+$.
  examplestringrequired
  Whats App Buttons Component (2 fields)
  typestringrequired
  One of buttons.
  buttonsarray of objectrequired
  At least 1 item.
  14 child fields
  typestringrequired
  One of quick_reply, url, phone_number, otp, copy_code, flow, mpm, catalog.
  textstring
  urlstring (URL)
  exampleany
  phone_numberstring
  otp_typestring
  One of copy_code, one_tap, zero_tap.
  autofill_textstring
  package_namestring
  signature_hashstring
  flow_idstring
  flow_namestring
  flow_jsonstring
  flow_actionstring
  navigate_screenstring
Whats App Limited Time Offer Component (2 fields)
- typestringrequired
  One of limited_time_offer.
- limited_time_offerobjectrequired
  2 child fields
  textstringrequired
  1 to 16 characters.
  has_expirationboolean
message_send_ttl_secondsinteger

Example

curl -X PATCH "https://api.pozy.ai/v1/whatsapp/templates/Acme" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9"
}'

const res = await fetch("https://api.pozy.ai/v1/whatsapp/templates/Acme", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    accountId: "696e0b682d0a31188e7a2ba9"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.patch(
    "https://api.pozy.ai/v1/whatsapp/templates/Acme",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
templateobject
- idstring
- namestring
- languagestring
- statusstring

200 response

{
  "success": true,
  "template": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "language": "en",
    "status": "active"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in WhatsApp

POSTRegister a connected WhatsApp number on the Cloud API POSTRequest a Meta re-verification code for a BYO WhatsApp number POSTVerify the Meta re-verification code for a BYO WhatsApp number GETDownload WhatsApp media GETList templates POSTCreate template GETGet template DELDelete template GETGet template by id PATCHUpdate template by id DELDelete template by id GETList the catalogs linked to a WhatsApp number POSTLink a catalog to a WhatsApp number DELUnlink a catalog from a WhatsApp number GETGet a number's commerce settings PUTUpdate a number's commerce settings GETGet ice breakers and commands POSTSet ice breakers and commands DELClear ice breakers and commands GETGet business profile POSTUpdate business profile POSTUpload profile picture GETGet display name status POSTRequest display name change GETGet business username POSTSet business username DELDelete business username GETGet username suggestions GETCheck if a user is blocked GETList blocked users POSTBlock users DELUnblock users GETList account notifications GETGet CTWA conversions dataset POSTProvision CTWA dataset GETList active groups POSTCreate group GETGet group info POSTUpdate group settings DELDelete group POSTAdd participants DELRemove participants POSTCreate invite link GETList join requests POSTApprove join requests DELReject join requests GETList conversion events POSTSend WhatsApp conversion event