BotPenguin for Partners
DocsSupport
  • Partner Onboarding
    • Introduction
    • Partner Onboarding
    • Understanding your plans
  • Partner PLATFORM GUIDELINES
    • Dashboard
    • Customer Management
    • Team Management
    • Plans Management
      • Configurations
      • Plans
      • Add-on
      • Invoices
    • Integration Setup
      • Setup Google reCAPTCHA
      • Setup AWS SES Account
      • Setup ChatGPT Account
      • Setup Zoho Integrations
      • Setup Google OAuth App
      • Setup RazorPay Account
      • Setup Stripe Account
      • Setup Facebook App for WhatsApp & Facebook Bots
        • Create Facebook Login for Business Configuration
        • Meta System User Token
    • Configurations
      • Retention Policy
      • Custom Domain
      • Custom Script
      • Bot templates
      • Whatsapp Templates
    • Subscriptions
    • Feedbacks
    • Brand & Account Management
  • Customer Platform Guidelines
    • New Bot Setup
      • Website Chatbot
      • WhatsApp Chatbot
        • ⚙️WhatsApp Bot Creation with Automated onboarding
        • 🐧Migration Of Whatsapp Account from other platforms to BotPenguin.
        • 🔃Reconnect Whatsapp Bot
      • Instagram Chatbot
      • Facebook Chatbot
      • Telegram Chatbot
      • Microsoft Teams Bot
    • Chatflow Setup
      • Components In Chatflow
        • Request Information
        • Send Information
        • Trigger Actions
      • 3rd Party API in Chatflows
        • ChatGPT
        • Create your custom integration
        • Call external APIs in your chat flows
    • Train Your AI Chatbot
    • Install your Website Chatbot
      • Install Website Bot on WordPress
      • Install Website Chatbot on Custom Build Website
      • Install Website Chatbot on Squarespace
    • Bot Settings
      • Website Chatbot Settings
        • Design
        • General
        • Alerts
        • Triggers
        • User Access
        • Chat Window
        • AI settings
        • Transfer Chat to WhatsApp Functionality
      • Telegram Chatbot Settings
        • General
        • Telegram Profile
      • Instagram Chatbot Settings
      • Facebook Chatbot Settings
      • WhatApp Chatbot Settings
        • General
        • Alerts
        • WhatsApp Profile
      • AI Settings
    • Automation Settings
      • WhatsApp Template Setup
      • WhatsApp Catalog Setup
      • WhatsApp Flows (Forms) Setup
      • WhatsApp Broadcast Setup
      • WhatsApp Drip Campaigns Setup
      • Facebook Auto-Reply Features
    • 3rd Party App Integrations
      • Integrate BotPenguin with Microsoft Teams
      • Integrate BotPenguin with WooCommerce
      • Integrate BotPenguin with Capsule CRM
      • Integrate BotPenguin with Elevio CRM
      • Integrate BotPenguin with Close CRM
      • Integrate BotPenguin with CalendarHero CRM
      • Integrate BotPenguin with Extraaedge CRM
      • Integrate BotPenguin with Infobip CRM
      • Integrate BotPenguin with Google Sheets
      • Integrate BotPenguin with Google Task
      • Integrate BotPenguin with HelpShift CRM
      • Integrate BotPenguin with Zendesk CRM
      • Integrate BotPenguin with LeadSquared CRM
      • Integrate BotPenguin with Zoho Desk
      • Integrate BotPenguin with SupportBee CRM
      • Integrate BotPenguin with Wealthbox CRM
      • Integrate BotPenguin with SendInBlue
      • Integrate BotPenguin with Apptivo CRM
      • Integrate BotPenguin with Freshdesk CRM
      • Integrate BotPenguin with Help Desk CRM
      • Integrate BotPenguin with Helpcrunch CRM
      • Integrate BotPenguin with Jira CRM
      • Integrate BotPenguin with KarmaCRM
      • Integrate BotPenguin with LiveAgent CRM
      • Integrate BotPenguin with NetHunt CRM
      • Integrate BotPenguin with Plivo CRM
      • Integrate BotPenguin with Recurly CRM
      • Integrate BotPenguin with Shipway CRM
      • Integrate BotPenguin with Zoho Projects
      • Integrate BotPenguin with Zoho CRM
      • Integrate BotPenguin with TeamGate CRM
      • Integrate BotPenguin with Agile CRM
      • Integrate BotPenguin with Pipedrive
      • Integrate BotPenguin with Drip CRM
      • Integrate BotPenguin with Google Calendar
      • Integrate BotPenguin with Groove
      • Integrate BotPenguin with Helpdocs
      • Integrate BotPenguin with Bitrix24
      • Integrate BotPenguin with GetResponse
      • Integrate BotPenguin with Freshworks CRM
      • Integrate BotPenguin with Insightly CRM
      • Integrate BotPenguin with Nimble CRM
      • Integrate BotPenguin with Nutshell CRM
      • Integrate BotPenguin with OntraPort CRM
      • Integrate BotPenguin with HubSpot
      • Integrate BotPenguin with WebHoper
      • Integrate BotPenguin with EngageBay
      • Integrate BotPenguin with Frontapp
      • Integrate BotPenguin with Copper
      • Integrate BotPenguin with Salesflare
      • Integrate BotPenguin with No CRM
      • Integrate BotPenguin with Helprace
      • Integrate BotPenguin with Flowlu
      • Integrate BotPenguin with Pipeline
      • Integrate BotPenguin with Zingtree
      • Integrate BotPenguin with Salesforce CRM
      • Integrate BotPenguin with Chakra CRM
      • Integrate BotPenguin with SimplyBook
      • Integrate Botpenguin with Zoho CRM
      • Integrate Botpenguin with Zapier
      • Integrate BotPenguin with Twilio
      • Integrate BotPenguin with Make.com
    • Inbox & Chat
    • Analytics
    • Teams
      • Team
      • Business hours
      • Members
      • Role
      • Using Teams in Chatflow
    • Customer's Subscription
    • Notifications
    • Developers
    • Account Management
      • Account
      • Password
      • Delete Account
    • Frequently Asked Questions (FAQs)
      • ❓Product FAQs
        • Onboarding FAQs
        • Edit your chat flow
        • Bot Installation FAQs
        • ChatGPT FAQs
        • Inbox FAQs
        • Analytics FAQs
        • Chat Flow FAQs
        • Bot Settings FAQs
        • Profile, Team & Notifications FAQs
        • WhatsApp FAQs
        • Product Update FAQs
        • Subscription FAQs
      • 🙋‍♂️Partner's FAQs
        • Onboarding
        • Affiliate Partner
        • Implementation Partner
        • Whitelabel Partner
        • WhatsApp Whitelabel Partner
        • Add-ons FAQs
        • Subscription FAQs
        • LTD FAQs
    • Chatbot Troubleshooting
  • PLATFORM UPDATES & INFO
    • 🔥What's New
    • 🐞Raise Bugs
    • 📄New Feature Request
    • 🐧BotPenguin Roadmap
    • ✍️Platform Feedback
    • 🔹Uptime Status
  • Developer Documentation
    • Partner API Documentation
      • Setting up environment
      • Get Customer
      • Create Customer
      • Update Customer
      • Delete Customer
      • Get Customer API Token
      • Get Team Members (Custom Users)
      • Get Custom User (Team Member) Token
      • Embedding the BotPenguin Inbox in 3rd Party Apps
    • API Token & Keys
      • Get All Contacts
      • Getting Groups/Segments
      • Add WhatsApp Contact
      • Delete WhatsApp Contact
      • Website Contacts & Meta Data
  • WhatsApp Cloud API by Meta
    • Setting Up Your Facebook Business Manager
    • Meta Conversation Pricing for WhatsApp Cloud API
    • Update WhatsApp Bot Profile
    • Getting a Blue Tick(previously Green Tick) on WhatsApp
  • WhatsApp Cloud API
    • GET Templates List
    • POST WhatsApp Template Message
    • POST Send Message API
  • Other
    • Terms & Conditions of Service
    • Privacy Policy
    • Service Level Agreement
    • Incident Management and Response Process
Powered by GitBook
On this page
  • API End Points
  • Request Headers
  • Query Params
  • Body
  • Example:

Was this helpful?

  1. WhatsApp Cloud API

POST WhatsApp Template Message

API to send the WhatsApp template message

Parameter Description

  1. userName: refers to the name of the user we intend to send the message

  2. wa_id: refers to the WhatsApp number of the user we intend to send the message NOTE: The number must contain the country code without the plus sign

  3. templateId: refers to the ID of the template NOTE: Template must be approved before using this API

  4. assingTo : refers to the email of custom user or agent.

  5. params: is used for the variables used in the template, it is an empty array in the case of a plain text template with no variables. In case of variables in the template, please refer to the JSON below

  6. tags: refers to label you can assign to conversations or chats to help organize and manage effectively.


API End Points

https://api-v7.express-chat.com/whatsapp-automation/wa/templates?apiKey=*API KEY*

Request Headers

Header
Details

apiKey

API KEY

Query Params

Header
Details

apiKey

API KEY

Body

{
    "userName": "Divyansh Test",
    "wa_id": "9175080****",
    "templateId": "62b5c16bf*****cfa9a72335",
    "params": [
			{
				"type" : "header",
				 "parameters": [
                {
                            "type": "document",
                            "document": {
                            "link": "<https://www.africau.edu/images/default/sample.pdf>"
                            }
                }
            ]
			},
			{
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Abc"
                        },
                         {
                            "type": "text",
                            "text": "def"
                        },
                         {
                            "type": "text",
                            "text": "Monday"
                        }
                    ]
        }
		 ],
		 "assignTo": "example@gmail.com",
		 "tags": [ "test" ]
}

Example:

Request

curl --location --request POST '<https://api-v7.express-chat.com/whatsapp-automation/wa/send-template?apiKey=> *Shared Separately*' \\
--header 'apiKey: *API KEY*' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "userName": "Test",
    "wa_id": "91885917****",
    "templateId": "63dba1617****52face07078",
    "params": [
        {
            "type": "header",
            "parameters": [
                {
                            "type": "document",
                            "document": {
                            "link": "<https://www.africau.edu/images/default/sample.pdf>"
                            }
                }
            ]
        },
        {
                    "type": "body",
                    "parameters": [
                        {
                            "type": "text",
                            "text": "Abc"
                        },
                         {
                            "type": "text",
                            "text": "def"
                        },
                         {
                            "type": "text",
                            "text": "Monday"
                        }
                    ]
        }

    ],
     "assignTo": "example@gmail.com",
     "tags": [ "test" ]
}'

Response

Header

Header
Details

X-Powered-By

Express

Vary

Origin

Access-Control-Allow-Credentials

true

_user

61c1c2058e0****e9bb420f8

_bot

62e77a807f1****ecce980f0

whatsAppId

****bsIWcYgazd5ZDAK

Content-Type

application/json; charset=utf-8

Content-Length

507

Etag

W/"1fb-urlVjgGZAUBRNyxQDAOnZ3ONF1I"

Date

Wed, 03 Aug 2022 11:16:13 GMT

Connection

keep-alive

Keep-Alive

timeout=5

PreviousGET Templates ListNextPOST Send Message API

Last updated 1 month ago

Was this helpful?