Login Cadastre-se

Remover lista de contatos

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

Remova listas de contatos cadastradas.

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

Informe o token da lista para remover uma lista específica.

Sim

String

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

Em caso de sucesso, retorna HTTP 200. Se access_token não for informado, retorna 400. Se a lista não for encontrada, retorna 404. Se a lista for padrão do sistema, retorna 403. 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": "Lista removida com sucesso."
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/lists/delete';

$payload = [
    'access_token' => 'LIST_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/lists/delete' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"access_token":"LIST_TOKEN"}'