Create WhatsApp group

Creates a new WhatsApp group on the app with the subject and initial members supplied in the request.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
messaging_productAlways "whatsapp"whatsapp—Required
subjectGroup name shown to participantsMy WhatsApp Group—Required
descriptionGroup descriptionGroup description—Optional

Sample cURL — Create WhatsApp group.

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/group' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "messaging_product" : "whatsapp",
  "subject" : "My WhatsApp Group",
  "description" : "Group description"
}'

Sample success response (200)

{
  "status": "success",
  "data": {
    "messaging_product": "whatsapp",
    "request_id": "0D4B30CD472BE1A554C75072A5311AB4"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

Body Params

messaging_product and subject are required; description is optional.

Create a WhatsApp group

string
enum
required

Always "whatsapp"

Allowed:
string
required

Group name shown to participants

string

Group description

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json