Login Cadastre-se

Criar lista de contatos

Endpoint: POST https://croncrm.com/api/v2/lists/create

Crie listas de contatos para organizar seus contatos.

Para alterar uma lista existente, utilize o endpoint PUT https://croncrm.com/api/v2/lists/change (veja Alterar lista de contatos).

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

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

Em caso de sucesso, retorna HTTP 201. Se name não for informado, retorna 400. Se já existir uma lista com o mesmo nome, retorna 409. 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 criada.

name: (String) Nome da lista.

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

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

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

Array

 
{
  "success": true,
  "msg": "Sua lista foi criada com sucesso.",
  "list": {
    "name": "testando criar lista de contatos pela API",
    "created": {
      "date": "2023-12-29 06:09:30",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "description": "descrição da lista",
    "access_token": "LIST_TOKEN"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/lists/create';

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

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    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 POST \
  'https://croncrm.com/api/v2/lists/create' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Lista de clientes","description":"Clientes ativos"}'