Login Cadastre-se

Alterar contato

Endpoint: PUT https://croncrm.com/api/v2/contacts-croncrm/change

Altere contatos cadastrados anteriormente.

IMPORTANTE: Certifique-se que todos os campos estejam preenchidos, pois ao deixar vazio será considerado que deseja apagar possíveis informações salvas.

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.

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 para deixar de receber suas mensagens.

Não

Boolean

list_access_token

Token da lista de contatos.

Sim

String

access_token

Token do contato que deseja alterar.

Sim

String

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

Em caso de sucesso, retorna HTTP 200. Se phone não for informado, retorna 400. Se list_access_token não for informado, retorna 400. Se access_token não for informado, retorna 400. Se a lista informada não for encontrada, retorna 400. Se o contato não for encontrado, 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"
    },
    "modified": {
      "date": "2024-12-02 02:10:11",
      "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/change';

$payload = [
    'name' => 'Fulano',
    'phone' => '559999999999',
    'list_access_token' => 'LIST_TOKEN',
    'variable01' => 'Cidade',
    'opt_out' => false,
    'access_token' => 'CONTACT_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/contacts-croncrm/change' \
  -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,"access_token":"CONTACT_TOKEN"}'