Add, promote or demote participants

curl --request POST \
  --url https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-Id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phoneNumbers": [
    "<string>"
  ],
  "action": "add"
}
'

import requests

url = "https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants"

payload = {
    "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phoneNumbers": ["<string>"],
    "action": "add"
}
headers = {
    "x-api-key": "<api-key>",
    "X-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'X-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    phoneNumbers: ['<string>'],
    action: 'add'
  })
};

fetch('https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants', 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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants",
  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([
    'channelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'phoneNumbers' => [
        '<string>'
    ],
    'action' => 'add'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Tenant-Id: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants"

	payload := strings.NewReader("{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("X-Tenant-Id", "<api-key>")
	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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants")
  .header("x-api-key", "<api-key>")
  .header("X-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}"

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

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

POST

wa-groups

{groupId}

participants

Add, promote or demote participants

curl --request POST \
  --url https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-Id: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phoneNumbers": [
    "<string>"
  ],
  "action": "add"
}
'

import requests

url = "https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants"

payload = {
    "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phoneNumbers": ["<string>"],
    "action": "add"
}
headers = {
    "x-api-key": "<api-key>",
    "X-Tenant-Id": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    'X-Tenant-Id': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    channelId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    phoneNumbers: ['<string>'],
    action: 'add'
  })
};

fetch('https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants', 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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants",
  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([
    'channelId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'phoneNumbers' => [
        '<string>'
    ],
    'action' => 'add'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Tenant-Id: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants"

	payload := strings.NewReader("{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("X-Tenant-Id", "<api-key>")
	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://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants")
  .header("x-api-key", "<api-key>")
  .header("X-Tenant-Id", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://social.linkiasoft.com/api/v1/whatsapp/wa-groups/{groupId}/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["X-Tenant-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"channelId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"phoneNumbers\": [\n    \"<string>\"\n  ],\n  \"action\": \"add\"\n}"

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

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, and channels:read to list channels. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Resource	Governed by
Contacts	`customers:*`
Activities	`customers:` for customer activities, `leads:` for lead activities
Tags	`customers:read` to list, `customers:manage` to change
Pipeline stages	`leads:*`
Quick replies	`quick-replies:read` / `quick-replies:write`
WhatsApp groups	`wa-groups:manage`

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id

string

header

required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Path Parameters

groupId

string

required

The provider's own group id — a Meta group id on the official provider, or the @g.us JID on the unofficial one (URL-encode it).

Body

application/json

channelId

string<uuid>

required

phoneNumbers

string[]

required

E.164 numbers without a plus.

action

enum<string>

default:add

Available options:

add,

promote,

demote

Response

Applied.

Delete or leave a group Remove participants

Conversations

Templates

Channels

Leads

Pipeline

Contacts

Activities

Customers

Tags

Quick replies

WhatsApp groups

Add, promote or demote participants

Authorizations

Path Parameters

Body

Response