Set description message of an existing group

With this endpoint, you will be able to set a text description for a group that was already created.

Parameters

You will need to obtain the UUID of the WhatsApp that you want to use. On this example, we will use WAG45b0f301-9203-4660-8b57-b51a6c2742a5 as the UUID.

These parameters should be sent as a JSON payload in the request body.

Field	Description	Example values
from_number	Your WhatsApp number that you connected to 2Chat	+12123334444
description	The text value of the description	This is a test description

Invocation

The group UUID is part of the path in the URL. For this example, we'll use WAG45b0f301-9203-4660-8b57-b51a6c2742a5 as the UUID.

tip

You can obtain the UUID of the group you want to target using the List Groups endpoint

cURL

curl -X POST --location 'https://api.p.2chat.io/open/whatsapp/group/WAG45b0f301-9203-4660-8b57-b51a6c2742a5/set-description' \
--header 'Content-Type: application/json' \
--header 'X-User-API-Key: your_api_key_here' \
--data '{
    "from_number": "+12123334444",
    "description": "This is a test description"
}'

Python

import requests
import json

url = "https://api.p.2chat.io/open/whatsapp/group/WAG45b0f301-9203-4660-8b57-b51a6c2742a5/set-description"

payload = json.dumps({
  "from_number": "+12123334444",
  "description": "This is a test description"
  })
headers = {
  'Content-Type': 'application/json',
  'X-User-API-Key': 'your_api_key_here'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JavaScript

const axios = require('axios');
let data = JSON.stringify({
  "from_number": "+12123334444",
  "description": "This is a test description"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.p.2chat.io/open/whatsapp/group/WAG45b0f301-9203-4660-8b57-b51a6c2742a5/set-description',
  headers: { 
    'Content-Type': 'application/json', 
    'X-User-API-Key': 'your_api_key_here'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.p.2chat.io/open/whatsapp/group/WAG45b0f301-9203-4660-8b57-b51a6c2742a5/set-description',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "from_number": "+12123334444",
    "description": "This is a test description"
  }',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'X-User-API-Key: your_api_key_here'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response

{
    "success": true,
}