Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function updateGroupSettings() {
  const response = await client.group.updateSettings({
    chat_id: '[email protected]',
    description: 'New description added'
  });

  console.log(response);
}

updateGroupSettings();
{
  "add_members_admins_only": true,
  "assigned_to": null,
  "chat_access": {
    "[email protected]": true
  },
  "chat_id": "[email protected]",
  "chat_image": null,
  "chat_name": "Test Group Name Change",
  "chat_type": "group",
  "closed_at": null,
  "created_at": "2025-01-27T11:07:52+00:00",
  "custom_properties": {},
  "group_description": null,
  "info_admins_only": false,
  "invite_link": "https://chat.whatsapp.com/invite/CuZAuEnSB6e8sk7R3dopD3",
  "is_exited": false,
  "is_muted": false,
  "label_ids": {},
  "labels": [],
  "latest_message": null,
  "member_count": 3,
  "messages_admins_only": false,
  "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
  "org_phone": "[email protected]",
  "updated_at": "2025-01-27T11:11:09.102583+00:00"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Path Parameters

​
chat_id
string
required

Body

application/json
​
addMembersAdminsOnly
boolean
  • When set to true, only admins can add other participants to the group
  • Default true
Example:

true

​
description
string
  • Updates the group description
Example:

""

​
image
string
  • A public image URL to update the group image
Example:

""

​
infoAdminsOnly
boolean
  • When set to true, only admins can edit group description or info
  • Default false
Example:

""

​
messagesAdminsOnly
boolean
  • When set to true, only admins can send messages to the group.
  • Default false
Example:

""

​
name
string
  • Updates the name of the group
Example:

"Test Group Name Change"

​
ephemeral
integer
  • Sets the disappearing message duration in WhatsApp group
  • 0: Off (no disappearing messages)
  • 1: 24 hours
  • 7: 7 days
  • 90: 90 days
Example:

7

Response

200 - application/json

200 OK

The response is a chat object for the updated group. Refer to the chat object here