Groups

Update group

Update group metadata.

Provide at least one of name or settings. Requires groups:write.

Request

curl -X PATCH "https://api.blueticks.co/v1/groups/" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "owner": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastMessageAt": "2019-08-24T14:15:22Z",
    "participantCount": 0,
    "announce": true,
    "restrict": true,
    "participants": [
      {
        "chatId": "string",
        "isAdmin": true,
        "isSuperAdmin": true,
        "name": "string"
      }
    ]
  }
}

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

Path Parameters

id*string

Request Body

application/json

name?string

Length1 <= length <= 100

settings?

Response

Response Body

`application/json`

Get group

Retrieve a single group by its `@g.us` id, including its subject, description, and (with `?include=participants`) its participant list.

Add member to group

Add a participant to the group by chatId (JID) or phone number in international format (e.g. +14155551234).

Update group

Request

Path Parameters

Request Body

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`