inbox.group_participants_update
Adicionar, remover, promover ou rebaixar participantes de um grupo. Age no grupo da conversa pelo número por QR, que precisa ser administrador do grupo. participants = telefones com DDI (só dígitos) ou JIDs ([email protected], ...@lid), até 50. Devolve o resultado de cada um como o WhatsApp informa (status "200" = feito; 403/409 = sem permissão ou já está/não está no grupo).
- Endpoint:
POST https://app.atomiks.com.br/api/v1/inbox.group_participants_update(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
messages:send - Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP:
inbox_group_participants_update - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdinbox.group_participants_update)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
conversationId | string (uuid) | sim | |
action | "add" | "remove" | "promote" | "demote" | sim | |
participants | string[] | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"conversationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"action": {
"type": "string",
"enum": [
"add",
"remove",
"promote",
"demote"
]
},
"participants": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 5,
"maxLength": 80
}
}
},
"required": [
"conversationId",
"action",
"participants"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/inbox.group_participants_update \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"conversationId":"00000000-0000-0000-0000-000000000000","action":"add","participants":["5511999990000"]}'CLI:
node cli/atomiks.mjs inbox.group_participants_update --json '{"conversationId":"00000000-0000-0000-0000-000000000000","action":"add","participants":["5511999990000"]}'MCP: ferramenta inbox_group_participants_update com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"jid": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"jid",
"status"
],
"additionalProperties": false
}
}
},
"required": [
"results"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).