Send a form via WhatsApp
curl --request POST \
--url https://api.pokulabs.com/forms/whatsapp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"required": false,
"placeholder": "<string>",
"helperText": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"validations": [
{
"title": "<string>",
"pattern": "<string>"
}
]
}
],
"to": "<string>",
"description": "<string>",
"brandImageUrl": "<string>",
"submitLabel": "Submit",
"waitTime": 60,
"followUpTime": 6000
}
'import requests
url = "https://api.pokulabs.com/forms/whatsapp"
payload = {
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"required": False,
"placeholder": "<string>",
"helperText": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"validations": [
{
"title": "<string>",
"pattern": "<string>"
}
]
}
],
"to": "<string>",
"description": "<string>",
"brandImageUrl": "<string>",
"submitLabel": "Submit",
"waitTime": 60,
"followUpTime": 6000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
fields: [
{
id: '<string>',
label: '<string>',
required: false,
placeholder: '<string>',
helperText: '<string>',
options: [{label: '<string>', value: '<string>'}],
validations: [{title: '<string>', pattern: '<string>'}]
}
],
to: '<string>',
description: '<string>',
brandImageUrl: '<string>',
submitLabel: 'Submit',
waitTime: 60,
followUpTime: 6000
})
};
fetch('https://api.pokulabs.com/forms/whatsapp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pokulabs.com/forms/whatsapp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'fields' => [
[
'id' => '<string>',
'label' => '<string>',
'required' => false,
'placeholder' => '<string>',
'helperText' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'validations' => [
[
'title' => '<string>',
'pattern' => '<string>'
]
]
]
],
'to' => '<string>',
'description' => '<string>',
'brandImageUrl' => '<string>',
'submitLabel' => 'Submit',
'waitTime' => 60,
'followUpTime' => 6000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pokulabs.com/forms/whatsapp"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pokulabs.com/forms/whatsapp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pokulabs.com/forms/whatsapp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}"
response = http.request(request)
puts response.read_body{
"values": {
"name": "John Smith",
"email": "johnsmith@gmail.com"
},
"content": "First & Last Name: John Smith\nEmail: johnsmith@gmail.com"
}Forms
Send form via WhatsApp
Send a link to a form via WhatsApp. When the recipient completes and submits the form, the contents are returned as a tool call response. Send from the Poku WhatsApp account, or use your own WhatsApp number with a Meta-approved template.
POST
/
forms
/
whatsapp
Send a form via WhatsApp
curl --request POST \
--url https://api.pokulabs.com/forms/whatsapp \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"required": false,
"placeholder": "<string>",
"helperText": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"validations": [
{
"title": "<string>",
"pattern": "<string>"
}
]
}
],
"to": "<string>",
"description": "<string>",
"brandImageUrl": "<string>",
"submitLabel": "Submit",
"waitTime": 60,
"followUpTime": 6000
}
'import requests
url = "https://api.pokulabs.com/forms/whatsapp"
payload = {
"title": "<string>",
"fields": [
{
"id": "<string>",
"label": "<string>",
"required": False,
"placeholder": "<string>",
"helperText": "<string>",
"options": [
{
"label": "<string>",
"value": "<string>"
}
],
"validations": [
{
"title": "<string>",
"pattern": "<string>"
}
]
}
],
"to": "<string>",
"description": "<string>",
"brandImageUrl": "<string>",
"submitLabel": "Submit",
"waitTime": 60,
"followUpTime": 6000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
fields: [
{
id: '<string>',
label: '<string>',
required: false,
placeholder: '<string>',
helperText: '<string>',
options: [{label: '<string>', value: '<string>'}],
validations: [{title: '<string>', pattern: '<string>'}]
}
],
to: '<string>',
description: '<string>',
brandImageUrl: '<string>',
submitLabel: 'Submit',
waitTime: 60,
followUpTime: 6000
})
};
fetch('https://api.pokulabs.com/forms/whatsapp', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pokulabs.com/forms/whatsapp",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'fields' => [
[
'id' => '<string>',
'label' => '<string>',
'required' => false,
'placeholder' => '<string>',
'helperText' => '<string>',
'options' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'validations' => [
[
'title' => '<string>',
'pattern' => '<string>'
]
]
]
],
'to' => '<string>',
'description' => '<string>',
'brandImageUrl' => '<string>',
'submitLabel' => 'Submit',
'waitTime' => 60,
'followUpTime' => 6000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pokulabs.com/forms/whatsapp"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pokulabs.com/forms/whatsapp")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pokulabs.com/forms/whatsapp")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"fields\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"required\": false,\n \"placeholder\": \"<string>\",\n \"helperText\": \"<string>\",\n \"options\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validations\": [\n {\n \"title\": \"<string>\",\n \"pattern\": \"<string>\"\n }\n ]\n }\n ],\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"brandImageUrl\": \"<string>\",\n \"submitLabel\": \"Submit\",\n \"waitTime\": 60,\n \"followUpTime\": 6000\n}"
response = http.request(request)
puts response.read_body{
"values": {
"name": "John Smith",
"email": "johnsmith@gmail.com"
},
"content": "First & Last Name: John Smith\nEmail: johnsmith@gmail.com"
}Authorizations
Authentication header containing your Poku API key. Find it in the Poku dashboard. The format is "Bearer YOUR_API_KEY"
Body
application/json
- Send from Poku WhatsApp
- Send from your own WhatsApp
When sending from Poku WhatsApp, the message is fixed and cannot be customized. The recipient receives: "Please fill out the following form." with a button that links to a dynamically generated form URL.
The title displayed at the top of the form.
An array of fields to display on the form.
Show child attributes
Show child attributes
The number you want to message, in E.164 format.
A subtitle or description shown below the title on the form.
URL of your logo, displayed at the top of the form above the title.
Label on the form's submit button. Defaults to "Submit".
Either this parameter or followUpTime must be supplied.
The number of seconds the API request is held open waiting for the form to be submitted. This is displayed as a countdown on the form. When the window expires, the agent moves on. The recipient can still submit the form within the followUpTime window.
Required range:
1 <= x <= 600Example:
60
Either this parameter or waitTime must be supplied.
After waitTime expires, how long Poku continues to accept a form submission. When the form is submitted within this window, the response is sent to any webhooks you've configured. Once this window closes, the form will show "This form has expired".
Required range:
1 <= x <= 60000Example:
6000