Login Cadastre-se

Adicionar/Remover etiqueta de uma conversa

Endpoint: PUT https://croncrm.com/api/v2/tags/add-remove-in-chat

Adicione ou remova etiquetas de conversas.

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

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

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

chat_wid

ID da conversa.

Sim

String

access_token

Token da etiqueta que deseja adicionar ou remover de uma conversa.

Sim

String

action

Tipo de ação que deseja executar.

  • add = Adiciona a etiqueta a conversa.
  • del = Remove a etiqueta da conversa.

Sim

String 

{
  "chat_wid": "[email protected]",
  "access_token": "TAG_TOKEN",
  "action": "add"
}
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se chat_wid, access_token ou action não forem informados (ou action for inválido), retorna 400. Se chat_wid for inválido, retorna 400. Se não for possível achar a etiqueta ou a conversa, retorna 422. Se a conversa não estiver vinculada à etiqueta (ao remover), 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 

{
  "success": true,
  "msg": "Etiqueta vinculada com sucesso."
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/tags/add-remove-in-chat';

$payload = [
    'chat_wid' => '[email protected]',
    'access_token' => 'TAG_TOKEN',
    'action' => 'add',
];

$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/tags/add-remove-in-chat' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chat_wid":"[email protected]","access_token":"TAG_TOKEN","action":"add"}'