> For the complete documentation index, see [llms.txt](https://help.pickyassist.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.pickyassist.com/api-documentation-v2/whatsapp-group-api/api-variables.md).

# API Variables

Below are the Variables which are in use with WhatsApp Groups

{% hint style="danger" %}

### If you have too many active WhatsApp Groups it may drastically slow down your WhatsApp automation server and may affect the regular WhatsApp sending and receiving speed, so please use group features carefully, there is no option to scale up the WhatsApp Web Automation beyond a certain limit.

{% endhint %}

{% hint style="danger" %}

### Delivery & Read Reports are not support for WhatsApp Groups

{% endhint %}

## Request Variables 

| Variable Name  | Type    | Description                                                                                                                                                                                                          |
| -------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| application    | Numeric | 10=WhatsApp Web Automation                                                                                                                                                                                           |
| group\_subject | String  | Subject of the Group, maximum 25 Characters                                                                                                                                                                          |
| group\_icon    | URL     | <p>Pass the Link of the picture be updated as group icon</p><p>File Size - 5 MB Recommended dimension : 640x640 File Type - .jpeg,png,jpg</p><p></p><p><strong>Not supported in WhatsApp Web Automation</strong></p> |
| group\_id      | String  | Unique Group ID which returns after creating a group                                                                                                                                                                 |
| number         | Numeric | WhatsApp number to make as admin, the number must be a member in the group, please pass country code along with number without 0 or +                                                                                |
| type           | Numeric | <p>0=Members</p><p>1=Admin</p>                                                                                                                                                                                       |
| action         | Numeric | <p>1=Delete Group Icon (<strong>Not supported in WhatsApp Web Automation)</strong> <br>2=Delete Invite URL<br>3=Leave Group </p>                                                                                     |

## Response Variables

| Variable Name        | Type    | Description                                                                                                                                    |
| -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| group\_id            | String  | This will return after creating a group , this id used to identify the group                                                                   |
| group\_invite\_ink   | Link    | This will return after creating a group , this link can be shared with users to join the group                                                 |
| group\_subject       | String  | Group Subject                                                                                                                                  |
| group\_icon\_link    | URL     | Group Icon Link (**Not supported in WhatsApp Web Automation)**                                                                                 |
| group\_admins        | Array   | <p>Array which contains admin details<br><br>number<br>created\_time</p>                                                                       |
| group\_members       | Array   | <p>Array which contains group member details <br><br>number<br>created\_time</p>                                                               |
| group\_created\_date | Date    | <p>Date & time when the groups is created,</p><p></p><p>Timezone in your account , and date format is DD-MM-YYYY hh:mm AM</p>                  |
| data                 | Array   | <p>Response Array when a group members or admins are removed <br></p><p>number<br>status<br><br>status</p><p>0 = Removed<br>1 = Failed<br></p> |
| status               | Numeric | Status of the request                                                                                                                          |
| message              | String  | Error / Sucess message of the request                                                                                                          |

## WhatsApp Group Error Codes

| **Error Code** | **WhatsApp Group Error Code** |
| -------------- | ----------------------------- |
| 833            | Group Subject Cannot Be Empty |
| 834            | Group Subject Length Exceeds  |
| 835            | Cannot Create Group           |
| 836            | Empty/Invalid Group ID        |
| 837            | Cannot Create Admin           |
| 838            | Cannot Process The Request    |
| 839            | Invalid Type                  |
| 840            | Invalid Whatsapp Number       |
| 841            | Numbers Not In The Group      |
| 842            | Invalid Action                |
| 844            | Invalid Permission Value      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.pickyassist.com/api-documentation-v2/whatsapp-group-api/api-variables.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.