Connections

POST /connections/{phoneNumber}/group-setting-update

Changed on

Update group settings (announcement/locked mode)

Request

  • Base URL
    http://localhost:3025
  • Auth
    API key in header x-api-key

Path parameters

phoneNumberstring required
Example:+551234567890

Phone number for connection. Must have + prefix.

Request body

jidstring required

Group JID

setting'announcement' | 'not_announcement' | 'locked' | 'unlocked' required

Group setting to update. announcement makes only admins able to send messages. not_announcement allows all participants. locked makes only admins able to edit group info. unlocked allows all participants to edit.

Example request

{
  "jid": "123456789012345678@g.us",
  "setting": "announcement"
}

Response

Group setting updated successfully

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status