Subscriber Assign Labels

POST

subscriber

chat

assign-labels

Assign Labels

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels \
  --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 'label_ids=1,4,5'

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels"

payload = {
    "apiToken": "API-KEY",
    "phone_number_id": "PHONE-NUMBER-ID",
    "phone_number": "PHONE-NUMBER",
    "label_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',
    label_ids: '1,4,5'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels', 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-labels",
  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&label_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-labels"

	payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_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-labels")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_ids=1%2C4%2C5")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels")

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&label_ids=1%2C4%2C5"

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

{
  "status": "1",
  "message": "Labels have been assigned successfully"
}

Assigns one or more labels to a subscriber.

label_ids is a comma-separated list such as 12,15. A list separated by spaces, or a JSON array, is rejected with No labels found. If some ids are valid and some aren’t, the valid ones are applied and the call still succeeds.

Where to find a label’s ID: open Subscriber Manager → Labels — the ID is shown next to each label name, ready to copy. Or call Label List to fetch all of them at once. See Finding Your IDs & API Token for a screenshot.

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"

phone_number_id

string

required

The WhatsApp account's phone number ID. Where to find it.

Example:

"PHONE-NUMBER-ID"

phone_number

string

required

The subscriber's phone number, with country code, digits only.

Example:

"PHONE-NUMBER"

label_ids

string

required

Comma-separated label IDs, e.g. 1,4,5. Where to find it.

Example:

"1,4,5"

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.

Assign Labels

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels \
  --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 'label_ids=1,4,5'

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels"

payload = {
    "apiToken": "API-KEY",
    "phone_number_id": "PHONE-NUMBER-ID",
    "phone_number": "PHONE-NUMBER",
    "label_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',
    label_ids: '1,4,5'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels', 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-labels",
  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&label_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-labels"

	payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_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-labels")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&label_ids=1%2C4%2C5")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/subscriber/chat/assign-labels")

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&label_ids=1%2C4%2C5"

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

{
  "status": "1",
  "message": "Labels have been assigned successfully"
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Subscriber Assign Labels

Body

Response