Skip to main content
Manage various group settings such as announce mode, locked status, name, topic, and photo.

​
Available Operations

​
Set Group Announce Mode

POST /group/announce Enable or disable announce mode so only admins can send messages.
​
group_id
string
required
The group IDExample: [email protected]
​
announce
boolean
required
Whether to enable announce mode (true) or disable it (false)

​
Set Group Locked Status

POST /group/locked Lock or unlock the group so only admins can modify group info.
​
group_id
string
required
The group ID
​
locked
boolean
required
Whether to lock the group (true) or unlock it (false)

​
Set Group Name

POST /group/name Update the group name (max 25 characters).
​
group_id
string
required
The group ID
​
name
string
required
The new group name (max 25 characters)Example: New Group Name

​
Set Group Topic

POST /group/topic Set or remove the group topic/description.
​
group_id
string
required
The group ID
​
topic
string
The group topic/description. Leave empty to remove the topic.Example: Welcome to our group! Please follow the rules.

​
Set Group Photo

POST /group/photo Upload a new group photo or remove the existing one.
​
group_id
string
required
The group ID
​
photo
file
Group photo to upload (JPEG format recommended). Leave empty to remove photo.

​
Request Examples

curl -X POST \
  'https://your-api-domain.com/group/announce' \
  -H 'Content-Type: application/json' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password' \
  -d '{
    "group_id": "[email protected]",
    "announce": true
  }'

​
Response

All group settings endpoints return a standard response:
​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the result
​
results
string
Additional result data (typically null or contains operation details)
{
  "code": "SUCCESS",
  "message": "Success",
  "results": null
}

Build docs developers (and LLMs) love

Get started for freeTalk to us