Subscribe contact by WhatsApp number
curl --request POST \
--url https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"whatsapp_number": "+8801712345678",
"status": true,
"name": "Jane Doe",
"email": "[email protected]",
"custom_input_value": [
{
"id": 2,
"value": "Custom answer"
}
]
}
'import requests
url = "https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number"
payload = {
"whatsapp_number": "+8801712345678",
"status": True,
"name": "Jane Doe",
"email": "[email protected]",
"custom_input_value": [
{
"id": 2,
"value": "Custom answer"
}
]
}
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({
whatsapp_number: '+8801712345678',
status: true,
name: 'Jane Doe',
email: '[email protected]',
custom_input_value: [{id: 2, value: 'Custom answer'}]
})
};
fetch('https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number', 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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number",
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([
'whatsapp_number' => '+8801712345678',
'status' => true,
'name' => 'Jane Doe',
'email' => '[email protected]',
'custom_input_value' => [
[
'id' => 2,
'value' => 'Custom answer'
]
]
]),
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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number"
payload := strings.NewReader("{\n \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number")
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 \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "Unauthenticated."
}{
"message": "Resource not found.",
"status": 404
}Newsletters
Subscribe (Number)
This endpoint subscribes a contact to a newsletter using their WhatsApp number. If the contact does not exist, a new one will be created with default values.
It also supports updating name, email, and custom input fields. If automation is configured for the newsletter, an automation instance will be created.
POST
/
workspaces
/
{workspace}
/
newsletters
/
{newsletter}
/
subscribe-number
Subscribe contact by WhatsApp number
curl --request POST \
--url https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"whatsapp_number": "+8801712345678",
"status": true,
"name": "Jane Doe",
"email": "[email protected]",
"custom_input_value": [
{
"id": 2,
"value": "Custom answer"
}
]
}
'import requests
url = "https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number"
payload = {
"whatsapp_number": "+8801712345678",
"status": True,
"name": "Jane Doe",
"email": "[email protected]",
"custom_input_value": [
{
"id": 2,
"value": "Custom answer"
}
]
}
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({
whatsapp_number: '+8801712345678',
status: true,
name: 'Jane Doe',
email: '[email protected]',
custom_input_value: [{id: 2, value: 'Custom answer'}]
})
};
fetch('https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number', 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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number",
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([
'whatsapp_number' => '+8801712345678',
'status' => true,
'name' => 'Jane Doe',
'email' => '[email protected]',
'custom_input_value' => [
[
'id' => 2,
'value' => 'Custom answer'
]
]
]),
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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number"
payload := strings.NewReader("{\n \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\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://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lancepilot.com/api/v3/workspaces/{workspace}/newsletters/{newsletter}/subscribe-number")
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 \"whatsapp_number\": \"+8801712345678\",\n \"status\": true,\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"custom_input_value\": [\n {\n \"id\": 2,\n \"value\": \"Custom answer\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"message": "Unauthenticated."
}{
"message": "Resource not found.",
"status": 404
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the workspace.
The newsletter ID
Body
application/json
WhatsApp phone number of the contact
Example:
"+8801712345678"
true = subscribed, false = unsubscribed
Example:
true
Example:
"Jane Doe"
Example:
Show child attributes
Show child attributes
Response
⌘I