Login Cadastre-se

Remover cliente

Endpoint: DELETE https://croncrm.com/api/v2/leads/delete

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

access_token

Token do cliente.

Sim

String

 
{
  "access_token": "LEAD_TOKEN"
}
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se access_token não for informado, retorna 400. Se o cliente 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

 
{
  "success": true,
  "msg": "Cliente removido com sucesso."
}

Observação: dependendo do histórico do cliente (ex.: orçamentos/arquivos), a remoção pode ser iniciada e retornar 200 com a mensagem Remoção do cliente iniciada. 

<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/leads/delete';

$payload = [
    'access_token' => 'LEAD_TOKEN',
];

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    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 DELETE \
  'https://croncrm.com/api/v2/leads/delete' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"access_token":"LEAD_TOKEN"}'