Login Cadastre-se

Alterar grupo

Endpoint: PUT https://croncrm.com/api/v2/groups/change

Altere informações e configurações de um grupo.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String
Body do request

Para alterar um campo, envie o valor desejado; campos omitidos não são alterados.

Atributo Descrição Obrigatório Tipo

chat_wid

WID do grupo.

Sim

String

name

Nome do grupo.

Não

String

description

Descrição do grupo.

Não

String

announce

Apenas admins podem enviar (0/1).

Não

0|1

restrict

Apenas admins podem editar info (0/1).

Não

0|1

ephemeral_duration

Mensagens temporárias (0/1).

Não

0|1

profile_picture

URL da foto do grupo.

Não

String (URL)

 
{
  "chat_wid": "[email protected]",
  "name": "Nome Atualizado",
  "announce": 1,
  "restrict": 0
}
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se chat_wid não for informado, retorna 422. Se chat_wid for inválido, retorna 400. Se o grupo não for encontrado, retorna 404. Método incorreto retorna 405; falhas inesperadas retornam 500.

Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

Boolean

msg

Mensagem de retorno.

String

group

Resultado das alterações solicitadas. Campos omitidos retornam null; campos enviados retornam o resultado do webservice.

Array

 
{
  "success": true,
  "msg": "Verifique se os parâmetros solicitados tiveram sucesso.",
  "group": {
        "name": {
            "success": true,
            "msg": "..."
        },
        "description": null,
        "announce": {
            "success": true,
            "msg": "..."
        },
        "restrict": null,
        "ephemeral_duration": null,
        "profile_picture": null
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/groups/change';

$payload = [
    'chat_wid' => '[email protected]',
    'name' => 'Nome Atualizado',
    'announce' => 1,
    'restrict' => 0,
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'apiKey: ' . $apiKey,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);

if ($error) {
    throw new RuntimeException($error);
}

echo "HTTP {$httpCode}\n";
echo $response;
?>
curl -X PUT \
  'https://croncrm.com/api/v2/groups/change' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","name":"Nome Atualizado","announce":1,"restrict":0}'