Connections

POST /connections/{phoneNumber}/group-join-approval-mode

Changed on

Toggle join approval mode for a group

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

mode'on' | 'off' required

Whether join requests require admin approval. on enables approval mode, off disables it.

Example request

{
  "jid": "123456789012345678@g.us",
  "mode": "on"
}

Response

Join approval mode 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