# `bird whatsapp groups create`

## Usage

```bash
bird whatsapp groups create [flags]
```

## Description

Create a WhatsApp group

Create a WhatsApp group administered by one of your business numbers. The number must hold Official Business Account status, which `bird whatsapp numbers list` reports as is\_official\_business\_account. The response is the accepted group with status pending; WhatsApp confirms it moments later, which is when the group gains its invite link and becomes messageable. Re-read the group until its status is active.

Build the request from flags, a JSON WhatsAppGroupCreate body via --body-file ("-" reads
stdin), or both — a flag overrides the matching body field. Run --example to
print a ready-to-edit body, or --dry-run to print the resolved request without
sending it.

## Procedure

Step 2 of 5 of "Create a WhatsApp group and let people into it". Previous: bird whatsapp numbers list. Next: bird whatsapp groups get.

## Examples

```bash
# print the body shape (no credentials needed)
bird whatsapp groups create --example

# the body it prints:
```

```json
{
  "description": "Jim would like to learn about new car purchase options for current year models.",
  "join_approval_mode": "auto_approve",
  "subject": "New Purchase Inquiry",
  "whatsapp_number_id": "wan_01krdgeqcxet5s7t44vh8rt9mg"
}
```

## Options

#### Request

| Name                | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| `--body-file`       | Read the JSON request body from this file; "-" reads stdin   |
| `--example`         | Print a complete example request body, then exit             |
| `--dry-run`         | Print the resolved request without sending it, then exit     |
| `--idempotency-key` | Deduplication key; a retry with the same key won't act twice |

#### Options

| Name                   | Description                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--whatsapp-number-id` | The business number that will own and administer the group, as its id in GET /v1/whatsapp/numbers. It must be a number your workspace can send from, and WhatsApp must have granted it Official Business Account status; a number without that status returns a 412 WhatsAppGroupsNotEligible. The number cannot be changed afterwards, and every message to the group is sent from it. (required; or in --body-file) |
| `--subject`            | The group's name, shown to participants and to anyone who opens the invite link. Surrounding whitespace is trimmed. (required; or in --body-file)                                                                                                                                                                                                                                                                     |
| `--description`        | The group's description, shown alongside the subject.                                                                                                                                                                                                                                                                                                                                                                 |
| `--join-approval-mode` | Whether opening the invite link joins the group outright, or raises a join request for you to approve. Defaults to auto\_approve. It cannot be changed once the group exists. Possible values: auto\_approve, approval\_required.                                                                                                                                                                                     |
| `--response-schema`    | Print the fields this command returns, then exit                                                                                                                                                                                                                                                                                                                                                                      |

## Related

| Name                                                                        | Description             |
| --------------------------------------------------------------------------- | ----------------------- |
| [`bird whatsapp groups delete`](/docs/cli/reference/whatsapp-groups-delete) | Delete a WhatsApp group |
| [`bird whatsapp groups get`](/docs/cli/reference/whatsapp-groups-get)       | Get a WhatsApp group    |
| [`bird whatsapp groups list`](/docs/cli/reference/whatsapp-groups-list)     | List WhatsApp groups    |
| [`bird whatsapp groups update`](/docs/cli/reference/whatsapp-groups-update) | Update a WhatsApp group |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)