Picky Assist Help Desk
Main WebsiteBlogFacebook Community
Picky Assist Help Desk
Picky Assist Help Desk
  • Welcome To Picky Assist ๐Ÿ™
  • Setting Up Guide
    • Sending First Message
    • Connecting Channels
      • WhatsApp Web Automation to Official API Migration Guide 2024
      • Connecting WhatsApp Web Automation
      • Connecting Facebook Messenger
        • Introduction
        • Getting Start
        • Guidelines & Compliances
        • Messenger Link
      • Connecting WhatsApp Official
        • Introduction
        • Dashboard
        • Profile
        • Templates
      • Connecting WhatsApp Cloud API
      • WhatsApp Official Managed Service
      • Connecting Instagram
      • Phone Bridge (Call Blaze)
      • Connecting SMTP
      • Connecting Amazon SES
      • Connecting Sendgrid
      • Connecting Additional WhatsApp Numbers
      • Porting WhatsApp Number to Picky Assist
      • WhatsApp Official Message Delivery Issues & Solutions
    • Working With Prebuilt CRM Modules
      • Introduction
      • Onboarding
      • Modules
        • Leads
        • Deals
        • Meetings
        • Company
        • Support Cases
        • System Modules
          • Contacts
          • Notes
          • Task
          • Call Logs
          • Tags
          • Activity Logs
      • Automations
        • Workflows
        • Chatbots
        • Funnels
        • Connectors
        • Scheduler
        • Other Prebuilt Features
      • Reports and Dashboard
      • Mandatory Preconditions for Using Prebuilt
      • Testing Prebuilt
    • Managing Organization
    • Setting Up Teambox
      • Introduction
      • Routing Rules
      • Teambox
      • Inbox View
      • Organization Hierarchy
      • Analytics
    • Setting Up Smart Replies
      • Introduction
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variations
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalising Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Testing the Bot
        • Publishing Bot
      • ChatGPT Integration
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Smart Reply V2
      • Introduction
      • ChatGPT Integration
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variation
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalizing Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Publishing Bot
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Setting Up Broadcaster
      • Introduction
      • Creating a Campagin
      • Sending Message to WhatsApp Groups
      • Reports
      • Broadcaster V2
        • Introduction
        • Creating Campaign
        • Reports
    • Setting Up Sequence
      • Introduction
      • Creating New Sequence
      • Sequence Stats
      • Subscribe & Unsubscribe
      • Disabling Sequence Message
    • Setting Up Reminder
    • Setting Up Mobile App
    • Setting Up Connector
      • Introduction
      • Getting Started
      • Steps
        • Introduction
        • Filters
        • Delay
        • Iterator
        • Stats
      • Actions
      • Formatter
        • Date & Time
        • Counter
        • Math Calculation
        • Data Parser
        • Convert File
        • Line Items
      • Building Mini App
      • Email Parser
      • Data Storage
      • Simulate Test
      • Connector Logs
    • Email Builder
    • Setting Up Flow Builder
      • Fundamentals (Must Read)
      • Basic Terminology (Must Read)
      • Guide to Building an Effective Chatbot (Must Read)
      • Create, Manage, Test & Publish Flows
      • Triggering a Chatbot Flow
      • Steps
        • Introduction (Must Read)
        • Send Message
        • Ask A Question
        • Filter
        • Save Data
        • Actions
        • Check WhatsApp Session
        • Delay
        • Smart Delay
        • Formatter
        • Splitter
        • Data Lookup
        • Trigger HTTP API
        • Webhook
        • Apps
        • Match Keywords
        • Route to Chatbot
        • End
      • Saving Data into CRM
      • Analytics
      • Integrations
      • Flow Builder logs and conversational logs
      • Chatbot Best Practices, Ideas & FAQ
    • Setting up Modular CRM
      • Fundamentals (Must Read)
      • Guide to Building and Implementing a Modular CRM (Must Read)
      • Create & Manage Data Modules
      • CRM Macro Buttons
      • Adding Records into CRM
      • Data View & Manage Records
      • Task
      • Workflows
      • Funnels
      • Data Import
      • Integrations
    • Setting Up Scheduler
    • Media Gallery
    • Quick Replies
    • Opt-out Settings
    • Blacklist
    • Global Variables
    • Setting Up Ad-On's
      • Setting Up WhatsMail
      • Setting Up Zendesk
      • Setting Up Zapier
      • Setting Up Zoho CRM
        • Getting Started
        • Working with Extension
        • Integrating with Zoho Workflow
        • Lead Assignment Rules
        • Integrating into Custom Modules
        • Connecting Multiple WhatsApp Numbers into Zoho CRM
        • Integrating WhatsApp with Zoho CRM Mobile App
        • Keyboard Shortcuts
      • Setting Up Facebook Lead Adform
      • Facebook Lead Ad form V2
      • Setting Up WhatsApp Web
      • Setting Up Pabbly Connect
      • Setting Up ChatGPT App
    • Google Chrome Extensions
      • Extension for Sending WhatsApp Messages from any Webpage
      • Chrome Extension V2
      • Extension for Zoho CRM & Teambox
    • Managing Profile
      • Two Factor Aunthentication
      • Login History
      • Delete Account
    • Quick Rollout Guide
      • WhatsApp Official Account
    • Developers & Partners Guide for Deep Integration of Picky Assist
  • API Documentation V2
    • Introduction
    • Quick Start Guide ๐Ÿƒ
    • Global Webhook
      • How Webhook Works
      • Webhook Variables
      • Configuring Webhook URL
      • Webhook Request & Response
      • Getting the Conversation Context
      • Testing Your Webhook
    • Event Webhook
      • How Event Webhook Works
      • Event Webhook Variables
      • Configuring Event Webhook URL
      • Event Webhook Sample Request & Response
    • Push API
      • Introduction
      • API Variables
      • Sending Single Message - Push
      • Sending Dynamic Messages โ€“ Push
      • Sending Media Attachments โ€“ Push
      • Sending Interactive List & Buttons
      • Sending Stickers
      • Sending Bulk Messages - Push
      • Sending Contacts
      • Sending Location
      • Sending WhatsApp Template Messages
        • Introduction
        • Sending WhatsApp Template Text Messages
        • Sending WhatsApp Template Image
        • Sending WhatsApp Template Document
        • Sending WhatsApp Interactive Buttons
        • Sending WhatsApp Limited Time Offer Templates
      • Sending Message to Groups
      • Sending SMS Using SIM Card
      • Sending Message to Facebook Messenger
      • Normal Post Method
      • Delivery Reports
      • Push API Must Read Instructions
      • Testing API Requests
    • WhatsApp Template API
      • Introduction
      • API Variables
      • Template Request API
      • Template Status API
      • Languages
      • Guidelines
    • WhatsApp Group API
      • Introduction
      • API Variables
      • Create Group
      • Set Group Permission
      • Add Group Admin
      • Add Group Members
      • Fetch Group Details
      • Update Group Info
      • Remove Group Members / Admin
      • Generate New Invite Link
      • Group Delete Actions
    • WhatsApp Settings API's
      • WhatsApp Profile API
      • 2 Step Verification
      • WhatsApp Status Update
      • WhatsApp Contact & Group Fetching
    • Device Manage APIโ€™s
      • Fetching Device Status API
      • Device Commands APIโ€™s
      • WhatsApp Automation Server Status API
    • Account API
      • Fetch Balance
    • Project Management API
      • Introduction
      • Create Project
      • Get Project Details
      • Set / Update Webhook
      • Create API Token
      • Manage API Token
      • Change Billing Plan
      • Fetch Account Balance
      • Country Code & Timezones
    • References
      • Status & Error Codes
      • Most Frequent Issues & Solutions
      • Formating & Sending Emojis ๐Ÿ˜Š
      • Postman Collection for Picky Assist API's
      • High Volume Messaging Bots - WhatsApp
    • Sample Codes
      • PHP
      • Python
      • Node JS
      • Ruby
      • Java
      • ASP.NET Using C#
      • Javascript
      • Go
      • Swift
      • C
      • C#
      • Objective C
  • General Guidelines
    • Billing
    • Adding Money Into Account
    • Rate Limits
    • Character Limits WhatsApp
    • Best Practices for Media Handling
    • Roadmap
    • Features In the Early Beta Version
  • Changelog
    • 2021
      • February 2021
      • March 2021
      • April 2021
      • May 2021
      • June 2021
    • 2020
      • February 2020
      • March 2020
      • April 2020
      • May 2020
      • June 2020
      • September 2020
      • October 2020
    • 2019
      • November 2019
      • October 2019
      • August 2019
      • September 2019
Powered by GitBook
On this page
  • Request URL
  • Sample Request - Text Template
  • Sample Response
  • Sample Request - Text Templates with Multiple Languages
  • Sample Media Template Request - Image
  • Sample Media Template Request - Image with Dynamic Header
  • Sample Media Template Request - Document
  • Sample Request - WhatsApp Interactive Button - Quick Replies with Text Message
  • Template API Request - Interactive Buttons URL & Phone Number
  • Template API Request - Interactive Buttons - URL
  • Sample Request - Add New Language
  • Sample Response

Was this helpful?

  1. API Documentation V2
  2. WhatsApp Template API

Template Request API

Below is the Sample Template Request API Request & Response for requesting new WhatsApp Templates.

To use this API your project must be enabled with WhatsApp Business Account.

Request URL

Method : POST

Requesting Templates

https://pickyassist.com/app/api/v2/template-request

Fetching Template Statuss

https://pickyassist.com/app/api/v2/template-status

Sample Request - Text Template

{ 
   "token":"782a357a2c11f54b83fd1a017f05eb6794",
   "name":"order_confirmation",
   "message_type":1,
   "category":2,
   "sample_message":["sample value of {{1}}","sample value of {{2}}","sample value of {{3}}"],
   "messages":[ 
      { 
         "message":"Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}.",
         "language":"en",
         "header":"test header Optional",
	 "footer":"test Optional"
      }
   ]
}

Sample Response

You need to save the "template_id" and should be used when sending WhatsApp Template Messages

{ 
   "template_id":"XY6479",
   "template_status":1,
   "status":100,
   "message":"Success"
}

Sample Request - Text Templates with Multiple Languages

{ 
   "token":"782a357a2c87687a11f54b83fd1a017f05eb6794",
   "name":"welcome",
   "message_type":1,
   "category":10,
   "sample_message":["sample value of {{1}}"],

   "messages":[ 
      { 
         "message":"Hello {{1}}, Welcome to Pickyassist",
         "language":"en"
         "header":"test header Optional",
	 "footer":"test Optional"
      },
      { 
         "message":"Bonjour {{1}}, Bienvenue chez Pickyassist",
         "language":"fr"
         "header":"test header Optional",
	 "footer":"test Optional"
      }
   ]
}

Sample Media Template Request - Image

{ 
   "token":"782a357a2c87687a11f54b83fd1a017f05eb6794",
   "name":"welcome_message",
   "message_type":2,
   "category":10,
   "sample_url":"https://pickyassist.com/en/img/product/telephony.png",
   "sample_message":["Diana"],
   "messages":[ 
      { 
         "message":"Hello {{1}}, Welcome to Picky Assist",
         "language":"en",
         "header":"Message from Picky Assist Team",
         "footer":"test Optional"
      }
   ]
}

Sample Media Template Request - Image with Dynamic Header

Kindly note that if you are passing dynamic header value then while sending the message you must pass the value of the dynamic variable, only one dynamic value is supported in the header

{ 
   "token":"782a357a2c87687a11f54b83fd1a017f05eb6794",
   "name":"welcome_message",
   "message_type":2,
   "category":10,
   "sample_url":"https://pickyassist.com/en/img/product/telephony.png",
   "sample_message":["Diana"],
   "sample_header":"Picky Assist",
   "messages":[ 
      { 
         "message":"Hello {{1}}, Welcome to Picky Assist",
         "language":"en",
         "header":"Message from {{1}}",
         "footer":"test Optional"
      }
   ]
}

Sample Media Template Request - Document

{ 
   "token":"782a357a2c87687a11f54b83fd1a017f05eb6794",
   "name":"welcome_message",
   "message_type":2,
   "category":10,
   "sample_url":"https://pickyassist.com/en/img/product/document.pdf",
   "sample_message":["Diana"],
   "messages":[ 
      { 
         "message":"Hello {{1}}, Please read the guidelines",
         "language":"en"
         "header":"ADMISSION Details",
         "footer":"test footer",
      }
   ]
}

Sample Request - WhatsApp Interactive Button - Quick Replies with Text Message

Please mind the template button position , the button will be shown to the user as per the order it's requested.

Once the template is approves it's not possible to change the order of the buttons.

{
	"token": "{{token}}",
	"name": "TEMPLATE-NAME",
	"message_type": 2,
	"category": 4,
	"messages": [
    	{
        	"message": "Hello {{1}}\\n\\nYour appointment for {{2}} with {{3}} is {{4}} on {{5}} Please confirm by clicking the below button\\n\\nThanks\\n{{6}}",
        	"language": "en",
        	"buttons": [
            	{
                	"type": 1,
                	"text": "Confirm"
            	},
            	{
                	"type": 1,
                	"text": "Cancel"
            	},
            	{
                	"type": 1,
                	"text": "Not Sure"
            	}
        	]
    	}
	]
}

Template API Request - Interactive Buttons URL & Phone Number

{
	"token": "{{token}}",
	"name": "delivery_out_button",
	"message_type": 1,
	"category": 4,
	"sample_message":["Danny", "Burger XL"],
	"messages": [
    	{
        	"message": "Hello {{1}}\n\nYour order {{2}} is out for delivery.",
        	"language": "en",
        	"buttons": [
                {
                	"type": 2,
                	"text": "Track Package ",
                	"url": "https://bridgerbot.com/app/api/wa/buttons/{{1}}}",
                        "sample_button_value":"EA454FFGQ21"
            	},
                {
                	"type": 3,
                	"text": "Call Support",
                	"phone_number": "+13026445173"
            	}
            	
                
        	]
    	}
	]
}

Template API Request - Interactive Buttons - URL

Only one dynamic variable is allowed and its should be at the end of the URL and from April 19th 2022 onwards dynamic variable is optional

Not possible to change the URL once its approved

{
	"token": "{{token}}",
	"name": "order_shipped_button",
	"message_type": 2,
	"category": 4,
	"messages": [
    	{
        	"message": "Hello {{1}}\n\nYour order {{2}} has been shipped through {{3}} on {{4}} and tracking number is {{5}}.\n\nThanks\n{{6}}",
        	"language": "en",
        	"buttons": [
            	{
                	"type": 2,
                	"text": "Track Order",
                	"url": "https://pickyassist.com/t/{{1}]"
            	}
        	]
    	}
	]
}

Sample Request - Add New Language

You can add new language to an existing template by passing the template id along with new language contents, please note there is no option to edit an existing template.

Please note if you have passed header and footer for the primary template then you must pass the same for all languages

{
    "token": "768b6b220c702c77225236",
    "template_id": "PV10560",
    "message": "Ciao {{1}}, \n\nIl tuo ordine {{2}} รจ stato annullato {{3}}\n\nGrazie\n{{4}}",
    "language": "it"
    "header": "header optional",
    "footer": "footer optional"
}

Sample Response

{
    "status":100,"message":"Success"
}

PreviousAPI VariablesNextTemplate Status API

Last updated 3 years ago

Was this helpful?