Skip to main content
PATCH
/
group
/
{id}
/
participants
cURL
curl --request PATCH \
  --url https://api.interacto.io/group/{id}/participants \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participants": [
    "551199999999"
  ],
  "action": "add"
}
'
{
  "id": "66c266130c991c46299dedf8",
  "wpId": "[email protected]",
  "instanceId": "66a09db606fd14660c8fc1d0",
  "name": "My Cool Group",
  "image": "",
  "participants": [
    "551199999999",
    "551188888888"
  ],
  "admins": []
}

Authorizations

​
Authorization
string
header
required

API Key needed to access the endpoints

Path Parameters

​
id
string
required

Body

application/json
​
participants
array
required

Participants of group

Example:
["551199999999"]
​
action
enum<string>
required

Action to perform on the participants

Available options:
add,
remove,
make_admin,
remove_admin
Example:

"add"

Response

Busca todos os grupos que voce tem

​
id
string

Unique identifier for the created group

Example:

"66c266130c991c46299dedf8"

​
wpId
string

Id do seu grupo no Whatsapp

Example:

"[email protected]"

​
instanceId
string

Id da instancia onde o seu grupo foi criado

Example:

"66a09db606fd14660c8fc1d0"

​
name
string

Nome que voce deu ao seu grupo

Example:

"My Cool Group"

​
image
string

Url da imagem do seu grupo

Example:

""

​
participants
array

Participantes que estao no seu grupo

Example:
["551199999999", "551188888888"]
​
admins
array

Admistradores que voce delegou

Example:
[]