Subscriber API
Subscriber Assign Sequences
Enroll a subscriber into one or more Sequences via the ChatSyncs API, using comma-separated sequence IDs. Use when a developer asks how to start an onboarding/drip campaign programmatically.
POST
/
whatsapp
/
subscriber
/
chat
/
assign-sequence
Assign Sequences
curl --request POST \
--url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data apiToken=API-KEY \
--data phone_number_id=PHONE-NUMBER-ID \
--data phone_number=PHONE-NUMBER \
--data 'sequence_ids=1,4,5'import requests
url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence"
payload = {
"apiToken": "API-KEY",
"phone_number_id": "PHONE-NUMBER-ID",
"phone_number": "PHONE-NUMBER",
"sequence_ids": "1,4,5"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
apiToken: 'API-KEY',
phone_number_id: 'PHONE-NUMBER-ID',
phone_number: 'PHONE-NUMBER',
sequence_ids: '1,4,5'
})
};
fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence', 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://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence"
payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5"
response = http.request(request)
puts response.read_body{
"status": "1",
"message": "Success."
}Enrolls a subscriber into one or more Sequences.
Where to find a sequence’s ID: open Chatbot Manager → Automation → Follow-up Sequences —
it’s the ID column shown next to each sequence. See
Finding Your IDs & API Token for a
screenshot.
Body
application/x-www-form-urlencoded
Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.
Example:
"API-KEY"
The WhatsApp account's phone number ID. Where to find it.
Example:
"PHONE-NUMBER-ID"
The subscriber's phone number, with country code, digits only.
Example:
"PHONE-NUMBER"
Comma-separated sequence IDs, e.g. 1,4,5. Where to find it.
Example:
"1,4,5"
Was this page helpful?
⌘I
Assign Sequences
curl --request POST \
--url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data apiToken=API-KEY \
--data phone_number_id=PHONE-NUMBER-ID \
--data phone_number=PHONE-NUMBER \
--data 'sequence_ids=1,4,5'import requests
url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence"
payload = {
"apiToken": "API-KEY",
"phone_number_id": "PHONE-NUMBER-ID",
"phone_number": "PHONE-NUMBER",
"sequence_ids": "1,4,5"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
apiToken: 'API-KEY',
phone_number_id: 'PHONE-NUMBER-ID',
phone_number: 'PHONE-NUMBER',
sequence_ids: '1,4,5'
})
};
fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence', 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://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence"
payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-sequence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&sequence_ids=1%2C4%2C5"
response = http.request(request)
puts response.read_body{
"status": "1",
"message": "Success."
}
