Login Cadastre-se

Alterar canal

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

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String
Body do request

access_token (obrigatório), name (obrigatório), webhooks opcionais

Atributo Descrição Obrigatório Tipo

access_token

Token do canal.

Sim

String

name

Novo nome do canal.

Sim

String

webhookMessage

URL do webhook para mensagens.

Não

String

webhookIncomingCall

URL do webhook para chamadas recebidas.

Não

String

webhookStateChanged

URL do webhook para mudanças de estado.

Não

String

webhookQrcode

URL do webhook para QR Code.

Não

String

webhookLiveLocation

URL do webhook para localização ao vivo.

Não

String

webhookParticipantsChanged

URL do webhook para mudanças de participantes.

Não

String

webhookAddedToGroup

URL do webhook para eventos de adição em grupo.

Não

String

 
{ "access_token": "INSTANCE_TOKEN", "name": "Canal Prod" }
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se name não for informado, retorna 400. Se access_token não for informado, retorna 400. Se algum webhook informado for inválido, retorna 400. Se o canal não existir, 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

instance

Dados do canal alterado.

name: (String) Nome do canal.

created: (String) Data de criação do canal.

modified: (String) Data da última alteração do canal.

type: (Object) Tipo do canal (code/name).

api_enable: (Boolean) Indica se a API está habilitada.

have_external_chatbot: (Boolean) Indica se possui chatbot externo.

in_log: (Boolean) Indica se está em log.

improved_synchronization: (Boolean) Indica se a sincronização aprimorada está habilitada.

webhooks: (Object) URLs de webhooks (message, incomingCall, stateChanged, qrcode, liveLocation, participantsChanged, addedToGroup).

api_key: (String) API Key do canal.

access_token: (String) Token do canal.

Object

 
{
    "success": true,
    "msg": "Canal alterado com sucesso.",
    "instance": {
        "name": "Canal Prod",
        "created": "01/01/2026 10:00:00",
        "modified": "01/01/2026 10:00:00",
        "type": {
            "code": 1,
            "name": "Desconhecido"
        },
        "api_enable": true,
        "have_external_chatbot": true,
        "in_log": false,
        "improved_synchronization": true,
        "webhooks": {
            "message": "",
            "incomingCall": "",
            "stateChanged": "",
            "qrcode": "",
            "liveLocation": "",
            "participantsChanged": "",
            "addedToGroup": ""
        },
        "api_key": "API_KEY",
        "access_token": "INSTANCE_TOKEN"
    }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/instances/change';

$payload = [
    'access_token' => 'INSTANCE_TOKEN',
    'name' => 'Canal Prod',
];

$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/instances/change' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"access_token":"INSTANCE_TOKEN","name":"Canal Prod"}'