Set Group Subject
Update the subject (name) of a WhatsApp group.
Set Group Subject
This endpoint allows you to change the subject (often referred to as the name) of a WhatsApp group.
Endpoint
PUT /{sessionId}/groups/{groupId}/subject
Headers
Name | Type | Required | Description |
---|---|---|---|
Authorization | string | Yes | Bearer token for authentication |
Content-Type | string | Yes | application/json |
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
sessionId | string | Yes | The session ID |
groupId | string | Yes | The group ID |
Request Body
Refer to SubjectRequest
in API.md
.
Field | Type | Required | Description |
---|---|---|---|
subject | string | Yes | The new subject for the group. Max 25 characters. |
Response
Returns a SubjectResponse
object. Refer to API.md
.
{
"success": true,
"subject": "New Awesome Group Subject",
"message": "Group subject updated successfully."
}
Examples
curl -X PUT "https://api.wasend.dev/YOUR_SESSION_ID/groups/YOUR_GROUP_ID/subject" \\
-H "Authorization: Bearer YOUR_API_KEY" \\
-H "Content-Type: application/json" \\
-d '{
"subject": "New Awesome Group Subject"
}'
import { WasendClient, WasendConfig, SubjectRequest, SubjectResponse } from '@wasend/core'; // Adjust imports
const config = new WasendConfig({ apiKey: 'YOUR_API_KEY' });
const client = new WasendClient(config);
const sessionId = 'YOUR_SESSION_ID';
const groupId = 'YOUR_GROUP_ID';
async function setGroupSubjectExample() {
const requestBody: SubjectRequest = {
subject: "New Awesome Group Subject"
};
try {
const response: SubjectResponse = await client.setGroupSubject(sessionId, groupId, requestBody);
if (response.success) {
console.log('Successfully set group subject:', response.subject);
console.log(response.message);
} else {
console.error('Failed to set group subject:', response.error);
}
} catch (error) {
console.error('Error setting group subject:', error);
}
}
setGroupSubjectExample();
const { WasendClient, WasendConfig } = require('@wasend/core'); // Adjust imports
const config = new WasendConfig({ apiKey: 'YOUR_API_KEY' });
const client = new WasendClient(config);
const sessionId = 'YOUR_SESSION_ID';
const groupId = 'YOUR_GROUP_ID';
async function setGroupSubjectExample() {
const requestBody = {
subject: "New Awesome Group Subject"
};
try {
const response = await client.setGroupSubject(sessionId, groupId, requestBody);
if (response.success) {
console.log('Successfully set group subject:', response.subject);
console.log(response.message);
} else {
console.error('Failed to set group subject:', response.error);
}
} catch (error) {
console.error('Error setting group subject:', error);
}
}
setGroupSubjectExample();
from wasend_sdk import WasendClient, WasendConfig # Adjust imports
config = WasendConfig(api_key='YOUR_API_KEY')
client = WasendClient(config)
session_id = 'YOUR_SESSION_ID'
group_id = 'YOUR_GROUP_ID'
request_body = {
'subject': "New Awesome Group Subject"
}
try:
response = client.set_group_subject(session_id=session_id, group_id=group_id, request=request_body)
if response.success:
print(f"Successfully set group subject: {response.subject}")
print(response.message)
else:
print(f"Failed to set group subject: {response.error}")
except Exception as e:
print(f"Error setting group subject: {e}")
package main
import (
"fmt"
"log"
"github.com/wasenddev/wasend-sdk-go/wasendcore" // Correct import path
)
func main() {
config := &wasendcore.WasendConfig{
ApiKey: "YOUR_API_KEY",
}
client := wasendcore.NewWasendClient(config)
sessionId := "YOUR_SESSION_ID"
groupId := "YOUR_GROUP_ID"
requestBody := &wasendcore.SubjectRequest{
Subject: "New Awesome Group Subject",
}
response, err := client.SetGroupSubject(sessionId, groupId, requestBody) // Assumes method exists
if err != nil {
log.Fatalf("Error setting group subject: %v", err)
}
if response.Success {
fmt.Printf("Successfully set group subject: %s\\n", response.Subject)
fmt.Println(response.Message)
} else {
fmt.Printf("Failed to set group subject: %s\\n", response.Error)
}
}
using System;
using Wasend.Core; // Adjust imports for WasendConfig, SubjectRequest, SubjectResponse
public class SetGroupSubjectExample
{
public static void Main(string[] args)
{
var config = new WasendConfig { ApiKey = "YOUR_API_KEY" };
var client = new WasendClient(config);
var sessionId = "YOUR_SESSION_ID";
var groupId = "YOUR_GROUP_ID";
var requestBody = new SubjectRequest
{
Subject = "New Awesome Group Subject"
};
try
{
var response = client.SetGroupSubject(sessionId, groupId, requestBody);
if (response.Success)
{
Console.WriteLine($"Successfully set group subject: {response.Subject}");
Console.WriteLine(response.Message);
}
else
{
Console.WriteLine($"Failed to set group subject: {response.Error}");
}
}
catch (Exception ex)
{
Console.WriteLine($"Error setting group subject: {ex.Message}");
}
}
}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpRequest.BodyPublishers;
public class SetGroupSubjectHttp {
public static void main(String[] args) {
String sessionId = "YOUR_SESSION_ID";
String groupId = "YOUR_GROUP_ID";
String apiKey = "YOUR_API_KEY";
String baseUrl = "https://api.wasend.dev";
String requestPayload = "{\"subject\": \"New Awesome Group Subject\"}";
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(baseUrl + "/" + sessionId + "/groups/" + groupId + "/subject"))
.header("Authorization", "Bearer " + apiKey)
.header("Content-Type", "application/json")
.PUT(BodyPublishers.ofString(requestPayload))
.build();
try {
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println("Response status: " + response.statusCode());
System.out.println("Response body: " + response.body());
// Parse JSON response
} catch (Exception e) {
e.printStackTrace();
}
}
}
<?php
$sessionId = 'YOUR_SESSION_ID';
$groupId = 'YOUR_GROUP_ID';
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://api.wasend.dev';
$payload = json_encode([
'subject' => 'New Awesome Group Subject'
]);
$ch = curl_init($baseUrl . '/' . $sessionId . '/groups/' . $groupId . '/subject');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiKey,
'Content-Type: application/json'
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo "HTTP status: " . $httpCode . "\\n";
echo "Response: " . $response . "\\n";
// Parse JSON response
?>
require 'net/http'
require 'uri'
require 'json'
session_id = 'YOUR_SESSION_ID'
group_id = 'YOUR_GROUP_ID'
api_key = 'YOUR_API_KEY'
base_url = 'https://api.wasend.dev'
uri = URI("#{base_url}/#{session_id}/groups/#{group_id}/subject")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = (uri.scheme == 'https')
request = Net::HTTP::Put.new(uri.path, {
'Authorization' => "Bearer #{api_key}",
'Content-Type' => 'application/json'
})
request.body = {
subject: "New Awesome Group Subject"
}.to_json
response_data = http.request(request)
puts "Response status: #{response_data.code}"
puts "Response body: #{response_data.body}"
# Parse JSON response
import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif
let sessionId = "YOUR_SESSION_ID"
let groupId = "YOUR_GROUP_ID"
let apiKey = "YOUR_API_KEY"
let baseUrl = "https://api.wasend.dev"
guard let url = URL(string: "\(baseUrl)/\(sessionId)/groups/\(groupId)/subject") else {
print("Invalid URL")
exit(1)
}
var request = URLRequest(url: url)
request.httpMethod = "PUT"
request.setValue("Bearer \(apiKey)", forHTTPHeaderField: "Authorization")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
let payload: [String: Any] = [
"subject": "New Awesome Group Subject"
]
do {
request.httpBody = try JSONSerialization.data(withJSONObject: payload, options: [])
} catch {
print("Error serializing JSON: \(error)")
exit(1)
}
let task = URLSession.shared.dataTask(with: request) { data, response, error in
if let error = error {
print("Error: \(error)")
return
}
guard let httpResponse = response as? HTTPURLResponse else {
print("Invalid response")
return
}
print("Response status code: \(httpResponse.statusCode)")
if let data = data, let responseBody = String(data: data, encoding: .utf8) {
print("Response body: \(responseBody)")
// Parse JSON response
}
#if os(macOS) || os(Linux)
CFRunLoopStop(CFRunLoopGetCurrent())
#endif
}
task.resume()
#if os(macOS) || os(Linux)
CFRunLoopRun()
#endif
use reqwest::Client;
use serde_json::json;
use tokio;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let session_id = "YOUR_SESSION_ID";
let group_id = "YOUR_GROUP_ID";
let api_key = "YOUR_API_KEY";
let base_url = "https://api.wasend.dev";
let client = Client::new();
let payload = json!({
"subject": "New Awesome Group Subject"
});
let response = client.put(format!("{}/{}/groups/{}/subject", base_url, session_id, group_id))
.bearer_auth(api_key)
.json(&payload)
.send()
.await?;
println!("Status: {}", response.status());
let body = response.text().await?;
println!("Body: {}", body);
// Parse JSON response
Ok(())
}
Response Fields
Field | Type | Description |
---|---|---|
success | boolean | Whether the operation was successful. |
subject | string | The updated group subject. |
message | string | A confirmation message. |
error | string | Optional. Error message if the request fails. |
Error Codes
Code | Description |
---|---|
400 | Bad Request - Invalid parameters (e.g., missing subject , subject too long/short). |
401 | Unauthorized - Invalid or missing API key. |
403 | Forbidden - User is not an admin or group settings prevent changes. |
404 | Not Found - Session or group not found. |
429 | Too Many Requests - Rate limit exceeded. |
500 | Internal Server Error. |
Notes
- The group subject (name) has a maximum length, typically 25 characters, enforced by WhatsApp. The API may also enforce this or a similar limit.
- Only group administrators can usually change the group subject, unless group settings (
infoAdminOnly
) allow all participants. - All group members will be notified of the subject change if successful.
- Emojis and special characters can often be used in group subjects.
- This endpoint is functionally similar to
set-name.mdx
if that also updates the group subject. Ensure consistency in usage and terminology based onAPI.md
.