Update Existing Template

curl --request PATCH \
  --url https://{projectID}.texterchat.com/server/api/v2/whatsapp/templates/{accountId}/{templateName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Updated Template",
  "chatStatus": 3,
  "usage": "bulk"
}
'

{
  "_id": "6891bb93481ccea320113a91",
  "name": "bulk_marketing_272",
  "title": "<string>",
  "usage": "inbox",
  "chatStatus": 0,
  "created": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "departments": [
    "<string>"
  ],
  "isDefault": true,
  "setBotNode": "<string>",
  "bot": "<string>",
  "replyText": "<string>",
  "responsibleAgent": "<string>",
  "responsibleDepartment": "<string>",
  "attachedFile": {
    "name": "<string>",
    "url": "<string>"
  },
  "provider": "<string>",
  "channelInfo": {
    "name": "whatsapp",
    "accountId": "972586640430"
  },
  "provider_template": {
    "name": "<string>",
    "category": "MARKETING",
    "localizations": [
      {
        "status": "REQUESTED",
        "rejectionReason": "NONE",
        "language": "he",
        "components": [
          {
            "type": "HEADER",
            "text": "<string>",
            "format": "IMAGE",
            "example": {
              "header_handle": [
                "<string>"
              ],
              "body_text": [
                [
                  "<string>"
                ]
              ],
              "header_text": [
                "<string>"
              ]
            },
            "buttons": [
              {
                "type": "QUICK_REPLY",
                "text": "<string>",
                "url": "<string>",
                "phone_number": "<string>",
                "flow_id": "<string>",
                "flow_action": "navigate",
                "navigate_screen": "<string>",
                "example": {
                  "url": "<string>"
                }
              }
            ]
          }
        ],
        "metadata": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "lastUpdated": "2023-11-07T05:31:56Z",
        "qualityScore": {
          "score": "<string>",
          "reasons": [
            "High block rate"
          ]
        }
      }
    ],
    "metadata": {}
  },
  "defaults": {},
  "localizationDrafts": {}
}

{
  "error": "data must have required property 'usage'"
}

"Not Found"

PATCH

https://{projectID}.texterchat.com/server/api/v2

templates

{accountId}

{templateName}

curl --request PATCH \
  --url https://{projectID}.texterchat.com/server/api/v2/whatsapp/templates/{accountId}/{templateName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Updated Template",
  "chatStatus": 3,
  "usage": "bulk"
}
'

{
  "_id": "6891bb93481ccea320113a91",
  "name": "bulk_marketing_272",
  "title": "<string>",
  "usage": "inbox",
  "chatStatus": 0,
  "created": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "departments": [
    "<string>"
  ],
  "isDefault": true,
  "setBotNode": "<string>",
  "bot": "<string>",
  "replyText": "<string>",
  "responsibleAgent": "<string>",
  "responsibleDepartment": "<string>",
  "attachedFile": {
    "name": "<string>",
    "url": "<string>"
  },
  "provider": "<string>",
  "channelInfo": {
    "name": "whatsapp",
    "accountId": "972586640430"
  },
  "provider_template": {
    "name": "<string>",
    "category": "MARKETING",
    "localizations": [
      {
        "status": "REQUESTED",
        "rejectionReason": "NONE",
        "language": "he",
        "components": [
          {
            "type": "HEADER",
            "text": "<string>",
            "format": "IMAGE",
            "example": {
              "header_handle": [
                "<string>"
              ],
              "body_text": [
                [
                  "<string>"
                ]
              ],
              "header_text": [
                "<string>"
              ]
            },
            "buttons": [
              {
                "type": "QUICK_REPLY",
                "text": "<string>",
                "url": "<string>",
                "phone_number": "<string>",
                "flow_id": "<string>",
                "flow_action": "navigate",
                "navigate_screen": "<string>",
                "example": {
                  "url": "<string>"
                }
              }
            ]
          }
        ],
        "metadata": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "lastUpdated": "2023-11-07T05:31:56Z",
        "qualityScore": {
          "score": "<string>",
          "reasons": [
            "High block rate"
          ]
        }
      }
    ],
    "metadata": {}
  },
  "defaults": {},
  "localizationDrafts": {}
}

{
  "error": "data must have required property 'usage'"
}

"Not Found"

Required token scopes: Manage WhatsApp templates

הרשאות

Authorization

string

header

נדרש

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

פרמטרי נתיב

accountId

string

נדרש

The account ID of the channel in Texter. For WhatsApp channels this is the phone number connected to the account (e.g. 972586640430)

templateName

string

נדרש

The unique identifier of the template. This is either the custom name assigned when the template was created, or the system-generated name returned by the Create New Template endpoint (under the name field)

Pattern: ^[a-zA-Z0-9_-]+$

גוף

application/json

title

string

נדרש

Internal title

chatStatus

enum<integer>

נדרש

Chat status after the recipient replies: 0 = BOT, 1 = PENDING, 2 = ASSIGNED, 3 = RESOLVED, 4 = BULK (accepted but not meaningful as a reply status)

אפשרויות זמינות:

0,

1,

2,

3,

4

usage

enum<string>

נדרש

Whether this template is intended to be sent individually (inbox) or in bulk (bulk)

אפשרויות זמינות:

inbox,

bulk

isDefault

boolean

Whether this template is the account default. Omitting this field resets it to false - re-send isDefault: true on every update of the default template. Only one template can be the default

departments

string[]

Department IDs that have access to this template. Omitting this field clears the list - always re-send the full list on update

setBotNode

string

If chatStatus is 0 (BOT), run the bot from this node. If not specified, the previously stored value is kept (it cannot be cleared via this endpoint)

responsibleAgent

string

The agent's user UID. Can't be combined with responsibleDepartment. Must be a UID, not an email - an email stored here silently fails to assign on reply. (Only the Send Template Message replyAction.responsibleAgent accepts email or UID.) Send null to clear

responsibleDepartment

string

Department ID. Can't be combined with responsibleAgent. Send null to clear

replyText

string

Text sent automatically when the recipient replies to the template

bot

string | null

The bot flow to run when the recipient replies (only meaningful when chatStatus is 0/BOT). Send null to clear

תגובה

The updated template object. Field-by-field reference: The Template object

A WhatsApp template in Texter, including internal behavior (chat routing rules, departments, defaults) and provider state (WhatsApp approval status, localized content)

_id

string

Unique identifier of the template in Texter

דוגמה:

"6891bb93481ccea320113a91"

name

string

Internal template name (also used as the template ID in API calls)

דוגמה:

"bulk_marketing_272"

title

string

Human-readable title shown in Texter's UI

usage

enum<string>

How this template is intended to be sent: inbox (1-to-1) or bulk (broadcast)

אפשרויות זמינות:

inbox,

bulk

chatStatus

enum<integer>

Status the chat moves to after the recipient replies to this template

אפשרויות זמינות:

0,

1,

2,

3,

4

created

number

When the template was created (epoch ms)

updatedAt

string<date-time>

departments

string[]

Department IDs allowed to use this template. Can be empty

isDefault

boolean

Whether this is the default template for the account. Only one template can be default

setBotNode

string

Bot node to trigger after reply, if chatStatus routes to bot

bot

string

Specific bot to run after reply, if chatStatus routes to bot

replyText

string

Text automatically sent when the recipient replies to the template

responsibleAgent

string

Agent (email) the chat is assigned to after the recipient replies

responsibleDepartment

string

Department ID the chat is assigned to after the recipient replies

attachedFile

object

File automatically sent when the recipient replies, when configured

Show child attributes

provider

string

Channel adapter that owns this template (relevant when multiple WhatsApp account types are connected)

channelInfo

object

The channel account this template belongs to

Show child attributes

provider_template

object

The template as registered with WhatsApp

Show child attributes

defaults

object

Default send values by language code, prefilled when sending the template if the caller does not provide overrides

Show child attributes

localizationDrafts

object

Map of language code to draft localization (created but not yet submitted/approved)

Show child attributes

Getting Started

Endpoints

Webhooks

Objects

Update Existing Template

הרשאות

פרמטרי נתיב

גוף

תגובה