Sign in
WhatsApp

Create group

Create a new WhatsApp group chat. Returns the group ID and optionally an invite link.

Not available on Coexistence numbers. Requires a Cloud API-only number.

post/v1/whatsapp/wa-groups

Request body

accountIdstring required

WhatsApp account ID

subjectstring required

Group name (max 128 characters)

descriptionstring

Group description (max 2048 characters)

joinApprovalMode'approval_required' | 'auto_approve'

Whether users need approval to join via invite link

Response

Group created

successboolean

Changes

Changed in 3 of the 56 revisions of this API.7

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3e6ddf2a99ea1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d752See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added