---
title: "Edit WhatsApp template"
method: PATCH
path: "/orgs/connections/{connection_id}/whatsapp/templates/{template_id}"
tags: ["WhatsApp"]
---

# Edit WhatsApp template

`PATCH /orgs/connections/{connection_id}/whatsapp/templates/{template_id}`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/connections/{connection_id}/whatsapp/templates/{template_id}`
- Auth: HTTP bearer

Edit an existing WhatsApp message template. Category and component changes may require Meta re-approval.

## Path parameters

- `connection_id` string, required
- `template_id` string, required

## Request body

- EditWhatsAppTemplateSchema
  - `waba_id` string, required
  - `category` 'AUTHENTICATION' | 'MARKETING' | 'UTILITY'
  - `parameter_format` 'POSITIONAL' | 'NAMED'
  - `components` WhatsAppTemplateComponentSchema[]
    - `type` string, required
    - `format` string
    - `text` string
    - `buttons` WhatsAppTemplateButtonSchema[]
      - `type` string, required
      - `text` string
      - `url` string
      - `phone_number` string
      - `example` string[]
      - `otp_type` string
      - `autofill_text` string
      - `zero_tap_terms_accepted` boolean
      - `supported_apps` WhatsAppTemplateSupportedAppSchema[]
        - `package_name` string, required
        - `signature_hash` string, required
      - `flow_id` string
      - `flow_name` string
      - `flow_action` string
      - `navigate_screen` string
    - `example` WhatsAppTemplateComponentExampleSchema
      - `header_text` string[]
      - `body_text` array[]
        - string[]
      - `header_handle` string[]
      - `header_url` string[]
      - `header_text_named_params` WhatsAppTemplateNamedParamSchema[]
        - `param_name` string, required
        - `example` string, required
      - `body_text_named_params` WhatsAppTemplateNamedParamSchema[]
        - `param_name` string, required
        - `example` string, required
    - `cards` WhatsAppTemplateCardSchema[]
      - `components` WhatsAppTemplateCardComponentSchema[], required
        - `type` string, required
        - `format` string
        - `text` string
        - `buttons` WhatsAppTemplateButtonSchema[]
          - `type` string, required
          - `text` string
          - `url` string
          - `phone_number` string
          - `example` string[]
          - `otp_type` string
          - `autofill_text` string
          - `zero_tap_terms_accepted` boolean
          - `supported_apps` WhatsAppTemplateSupportedAppSchema[]
            - `package_name` string, required
            - `signature_hash` string, required
          - `flow_id` string
          - `flow_name` string
          - `flow_action` string
          - `navigate_screen` string
        - `example` WhatsAppTemplateComponentExampleSchema
          - `header_text` string[]
          - `body_text` array[]
            - string[]
          - `header_handle` string[]
          - `header_url` string[]
          - `header_text_named_params` WhatsAppTemplateNamedParamSchema[]
            - `param_name` string, required
            - `example` string, required
          - `body_text_named_params` WhatsAppTemplateNamedParamSchema[]
            - `param_name` string, required
            - `example` string, required
    - `add_security_recommendation` boolean
    - `code_expiration_minutes` number
    - `limited_time_offer` WhatsAppTemplateLimitedTimeOfferSchema
      - `text` string, required
      - `has_expiration` boolean
  - `message_send_ttl_seconds` number

## Response `200`

- WhatsAppTemplateSchema
  - `id` string, required
  - `waba_id` string, required
  - `name` string, required
  - `language` string, required
  - `status` 'APPROVED' | 'IN_APPEAL' | 'PENDING' | 'REJECTED' | 'PENDING_DELETION' | 'DELETED' | 'DISABLED' | 'PAUSED' | 'LIMIT_EXCEEDED', required
  - `category` 'AUTHENTICATION' | 'MARKETING' | 'UTILITY', required
  - `components` WhatsAppTemplateComponentSchema[], required
    - `type` string, required
    - `format` string
    - `text` string
    - `buttons` WhatsAppTemplateButtonSchema[]
      - `type` string, required
      - `text` string
      - `url` string
      - `phone_number` string
      - `example` string[]
      - `otp_type` string
      - `autofill_text` string
      - `zero_tap_terms_accepted` boolean
      - `supported_apps` WhatsAppTemplateSupportedAppSchema[]
        - `package_name` string, required
        - `signature_hash` string, required
      - `flow_id` string
      - `flow_name` string
      - `flow_action` string
      - `navigate_screen` string
    - `example` WhatsAppTemplateComponentExampleSchema
      - `header_text` string[]
      - `body_text` array[]
        - string[]
      - `header_handle` string[]
      - `header_url` string[]
      - `header_text_named_params` WhatsAppTemplateNamedParamSchema[]
        - `param_name` string, required
        - `example` string, required
      - `body_text_named_params` WhatsAppTemplateNamedParamSchema[]
        - `param_name` string, required
        - `example` string, required
    - `cards` WhatsAppTemplateCardSchema[]
      - `components` WhatsAppTemplateCardComponentSchema[], required
        - `type` string, required
        - `format` string
        - `text` string
        - `buttons` WhatsAppTemplateButtonSchema[]
          - `type` string, required
          - `text` string
          - `url` string
          - `phone_number` string
          - `example` string[]
          - `otp_type` string
          - `autofill_text` string
          - `zero_tap_terms_accepted` boolean
          - `supported_apps` WhatsAppTemplateSupportedAppSchema[]
            - `package_name` string, required
            - `signature_hash` string, required
          - `flow_id` string
          - `flow_name` string
          - `flow_action` string
          - `navigate_screen` string
        - `example` WhatsAppTemplateComponentExampleSchema
          - `header_text` string[]
          - `body_text` array[]
            - string[]
          - `header_handle` string[]
          - `header_url` string[]
          - `header_text_named_params` WhatsAppTemplateNamedParamSchema[]
            - `param_name` string, required
            - `example` string, required
          - `body_text_named_params` WhatsAppTemplateNamedParamSchema[]
            - `param_name` string, required
            - `example` string, required
    - `add_security_recommendation` boolean
    - `code_expiration_minutes` number
    - `limited_time_offer` WhatsAppTemplateLimitedTimeOfferSchema
      - `text` string, required
      - `has_expiration` boolean
  - `quality_score` WhatsAppTemplateQualityScoreSchema
    - `score` string, required
    - `date` number
  - `rejected_reason` string
  - `correct_category` 'AUTHENTICATION' | 'MARKETING' | 'UTILITY', nullable
  - `source` string: AUTO_GENERATED when Meta created the template for a Direct Send update; absent on templates the business authored

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)
