Skip to main content
POST
/
v1
/
whatsapp
/
instances
/
{instanceId}
/
groups
/
participants
curl --request POST \
  --url https://api.notifique.dev/v1/whatsapp/instances/{instanceId}/groups/participants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "120363295648424210@g.us"
  ],
  "action": "add",
  "participants": [
    "5511999999999"
  ]
}
'
{
  "success": true,
  "data": {
    "results": [
      {
        "groupJid": "120363295648424210@g.us",
        "success": true,
        "action": "add",
        "participantsCount": 1
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Path Parameters

​
instanceId
string
required

Body

application/json
​
action
enum<string>
required
Available options:
add,
remove
​
participants
string[]
required

Números com DDI ou JIDs (ex.: 5511999999999)

Minimum array length: 1
​
to
string[]

JIDs dos grupos (ex.: 120363295648424210@g.us). Obrigatório se groupJid não for enviado.

Required array length: 1 - 100 elements
Pattern: ^\d+@g\.us$
​
groupJid
string

Deprecated. Use to. JID de um único grupo; equivale a to: [groupJid].

Response

data.results: um item por grupo. Sucesso: groupJid, success: true, action, participantsCount. Falha: groupJid, success: false, error.

​
success
boolean
Example:

true

​
data
object