Atualizar participantes do grupo

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
      }
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

POST

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
      }
    ]
  }
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

{
  "success": false,
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "note": "<string>"
}

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

instanceId

string

obrigatório

Corpo

application/json

action

enum<string>

obrigatório

Opções disponíveis:

add,

remove

participants

string[]

obrigatório

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

Minimum array length: 1

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].

Resposta

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

success

boolean

Exemplo:

true

data

object

Show child attributes

Listar participantes do grupo Enviar convite de grupo