Groups

Create group

Create a WhatsApp group with the given name and initial participants.

Requires groups:write.

Request

curl -X POST "https://api.blueticks.co/v1/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "Q4 Planning",    "participants": [      "+15555550100",      "+15555550101"    ]  }'

{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "owner": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "last_message_at": "2019-08-24T14:15:22Z",
    "participant_count": 0,
    "announce": true,
    "restrict": true,
    "participants": [
      {
        "chat_id": "string",
        "is_admin": true,
        "is_super_admin": true,
        "name": "string"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "details": [
      {
        "path": "string",
        "code": "string",
        "message": "string"
      }
    ]
  }
}

Request Body

application/json

name*string

Length1 <= length <= 100

participants*array<string>

Items1 <= items <= 256

Response

Response Body

`application/json`

List groups

List the groups the connected WhatsApp engine sees.

Get group

Retrieve a single group by its `@g.us` id, including its subject, description, and participant list.

Create group

Request

Request Body

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`