דלג לתוכן הראשי
PATCH
/
whatsapp
/
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",
  "replyText": "המספר הזה מיועד למענה אוטומטי בלבד, נא לפנות אלינו באמצעי התקשורת האחרים."
}
'
{
  "_id": "6891bb93481ccea320113a91",
  "name": "bulk_marketing_272",
  "title": "<string>",
  "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": {
    "accountId": "972586640430"
  },
  "provider_template": {
    "name": "<string>",
    "category": "MARKETING",
    "localizations": [
      {
        "rejectionReason": "NONE",
        "language": "he",
        "components": [
          {
            "text": "<string>",
            "example": {
              "header_handle": [
                "<string>"
              ],
              "body_text": [
                [
                  "<string>"
                ]
              ]
            },
            "buttons": [
              {
                "text": "<string>",
                "url": "<string>",
                "phone_number": "<string>",
                "flow_id": "<string>",
                "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": {}
}

הרשאות

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

אפשרויות זמינות:
0,
1,
2,
3
usage
enum<string>
נדרש

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

אפשרויות זמינות:
inbox,
bulk
isDefault
boolean

If not specified it remains unchanged. Only one template can be the default

departments
string[]

Department IDs that have access to this template

setBotNode
string

If chatStatus is 0 (BOT), run the bot from this node. If not specified, the bot runs from its starting node

responsibleAgent
string

Agent email. Can't be combined with responsibleDepartment

responsibleDepartment
string

Department ID. Can't be combined with responsibleAgent

replyText
string

Text sent automatically when the recipient replies to the template

תגובה

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

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

provider_template
object

The template as registered with WhatsApp

defaults
object

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

localizationDrafts
object

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