Create Subscriber

POST

subscriber

create

Create Subscriber

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiToken=API-KEY \
  --data phoneNumberID=PHONE-NUMBER-ID \
  --data name=NAME \
  --data phoneNumber=MOBILE

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create"

payload = {
    "apiToken": "API-KEY",
    "phoneNumberID": "PHONE-NUMBER-ID",
    "name": "NAME",
    "phoneNumber": "MOBILE"
}
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',
    phoneNumberID: 'PHONE-NUMBER-ID',
    name: 'NAME',
    phoneNumber: 'MOBILE'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create', 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/create",
  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&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE",
  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/create"

	payload := strings.NewReader("apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE")

	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/create")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create")

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&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE"

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": "WhatsApp subscriber has been created."
}

Creates a subscriber (contact) on a connected WhatsApp number, without requiring them to message your bot first — useful for importing existing contacts from a CRM or signup form.

Nothing is validated. A phoneNumber such as abc creates a contact with an empty chat ID, which can then never be looked up or deleted through the API, and an empty name is accepted too. Validate both before calling — the phone number must be digits only, country code first, no +. Every contact counts toward your subscriber limit.

If the contact already exists the response is {"status":"0","message":"Something went wrong or subscriber already exist."}.

Body

application/x-www-form-urlencoded

apiToken

string

required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

phoneNumberID

string

required

The WhatsApp account's phone number ID to create this subscriber under. (Note: camelCase.) Where to find it.

Example:

"PHONE-NUMBER-ID"

name

string

required

The subscriber's name.

Example:

"NAME"

phoneNumber

string

required

The subscriber's number, with country code and no + sign, digits only. (Note: camelCase.)

Example:

"MOBILE"

Response

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status

string

"1" = success, "0" = failure.

message

string

Human-readable result message.

Create Subscriber

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiToken=API-KEY \
  --data phoneNumberID=PHONE-NUMBER-ID \
  --data name=NAME \
  --data phoneNumber=MOBILE

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create"

payload = {
    "apiToken": "API-KEY",
    "phoneNumberID": "PHONE-NUMBER-ID",
    "name": "NAME",
    "phoneNumber": "MOBILE"
}
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',
    phoneNumberID: 'PHONE-NUMBER-ID',
    name: 'NAME',
    phoneNumber: 'MOBILE'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create', 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/create",
  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&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE",
  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/create"

	payload := strings.NewReader("apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE")

	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/create")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/create")

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&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE"

response = http.request(request)
puts response.read_body

{
  "status": "1",
  "message": "WhatsApp subscriber has been created."
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Body

Response