Login Cadastre-se

Criar contato

Endpoint: POST https://croncrm.com/api/v2/contacts-croncrm/create

Crie contatos.

IMPORTANTE: Todo contato precisa estar vinculado a uma lista de contatos, então antes de criar um contato você precisa ter uma lista.

ATENÇÃO: Contatos com números inválidos serão removidos da plataforma em até 7 dias corridos.

Para alterar um contato existente, utilize o endpoint PUT https://croncrm.com/api/v2/contacts-croncrm/change (veja Alterar contato).

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 do contato.

Não

String

phone

Informe o número do contato completo com DDI do país e DDD do estado.

Veja o exemplo para o número 55 (21) 3005-9146:

DDI: 55 é o código do Brasil.

DDD: 21 é o código do estado do Rio de Janeiro.

NÚMERO: 3005-7593 é o número do contato.

Sim

String

variable01

Salve qualquer tipo de informação neste campo.

Não

String

variable02

Salve qualquer tipo de informação neste campo.

Não

String

variable03

Salve qualquer tipo de informação neste campo.

Não

String

variable04

Salve qualquer tipo de informação neste campo.

Não

String

variable05

Salve qualquer tipo de informação neste campo.

Não

String

variable06

Salve qualquer tipo de informação neste campo.

Não

String

description

Salve observações sobre o contato.

Não

String

opt_out

Informe se o contato solicitou em algum momento para deixar de receber suas mensagens.

  • TRUE = Se solicitou para deixar de receber mensagens.
  • FALSE = Envio de mensagens liberada.

IMPORTANTE: Este recurso só impede o envio de mensagens agendadas pela plataforma.

Não

Boolean

list_access_token

Token da lista de contatos.

Sim

String

 
{
  "name": "Fulano",
  "phone": "559999999999",
  "list_access_token": "LIST_TOKEN",
  "variable01": "Cidade",
  "opt_out": false
}
Response do request

Em caso de sucesso, retorna HTTP 201. Se phone não for informado, retorna 400. Se list_access_token não for informado, retorna 400. Se a lista informada não for encontrada, retorna 400. Se o contato já existir nesta lista, retorna 400. 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

contact

Dados do contato salvo.

Confira aqui o detalhamento de cada atributo de um contato.

Array

 
{
  "success": true,
  "msg": "Contato salvo com sucesso.",
  "contact": {
    "name": "",
    "created": {
      "date": "2024-12-02 02:08:06",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "phone": "5521xxxxxxxxx",
    "phone_wid": "",
    "variable01": "",
    "variable02": "",
    "variable03": "",
    "variable04": "",
    "variable05": "",
    "variable06": "",
    "description": "",
    "access_token": "CONTACT_TOKEN",
    "have_whatsapp": 4,
    "opt_out": false,
    "opt_out_datetime": "",
    "list": {
      "name": "Lista de contatos para teste",
      "access_token": "LIST_TOKEN"
    }
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/contacts-croncrm/create';

$payload = [
    'name' => 'Fulano',
    'phone' => '559999999999',
    'list_access_token' => 'LIST_TOKEN',
    'variable01' => 'Cidade',
    'opt_out' => false,
];

$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/contacts-croncrm/create' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Fulano","phone":"559999999999","list_access_token":"LIST_TOKEN","variable01":"Cidade","opt_out":false}'