Login Cadastre-se

Alterar lista de contatos

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

Altere uma lista de contatos já existente.

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

name

Informe o nome da lista.

Sim

String

description

Informe uma descrição para a lista.

Não

String

access_token

Informe o access_token da lista.

Sim

String

 
{
  "name": "Lista de clientes",
  "description": "Clientes ativos",
  "access_token": "LIST_TOKEN"
}
Response do request

Em caso de sucesso, retorna HTTP 200. Se name não for informado, retorna 400. Se access_token não for informado, retorna 400. Se a lista não for encontrada, 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

list

Dados da lista alterada.

name: (String) Nome da lista.

created: (DateTime) Data e hora que foi criada.

modified: (DateTime) Data e hora da última alteração.

description: (String) Descrição da lista.

access_token: (String) Token gerado pelo CRONCRM para a lista.

Array

 
{
  "success": true,
  "msg": "Sua lista foi atualizada com sucesso.",
  "list": {
    "name": "Lista de clientes",
    "created": {
      "date": "2023-12-29 06:09:30",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "modified": {
      "date": "2023-12-29 06:10:11",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "description": "Clientes ativos",
    "access_token": "LIST_TOKEN"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/lists/change';

$payload = [
    'name' => 'Lista de clientes',
    'description' => 'Clientes ativos',
    'access_token' => 'LIST_TOKEN',
];

$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/lists/change' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Lista de clientes","description":"Clientes ativos","access_token":"LIST_TOKEN"}'