Login Cadastre-se

Criar etiqueta

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

Cria etiquetas para vincular em suas conversas.

IMPORTANTE: Para buscar conversas vinculadas a uma etiqueta, utilize o método Conversas -> Buscar conversa.

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 etiqueta.

Sim

String

description

Informe uma descrição para a etiqueta.

Não

String

color

Informe a cor da etiqueta.

Sim

String 

{
  "name": "VIP",
  "description": "Clientes especiais",
  "color": "#FF9900"
}
Response do request

Em caso de sucesso, retorna HTTP 201. Se name não for informado, retorna 400. Se color for informado mas não for hexadecimal válido, retorna 400. Se já existir uma etiqueta 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

tag

Dados da etiqueta criada.

name: (String) Nome da etiqueta.

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

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

color: (String) Cor da etiqueta.

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

Array 

{
  "success": true,
  "msg": "Sua etiqueta foi criada com sucesso.",
  "tag": {
    "name": "Testando criação de etiqueta pela API",
    "created": {
      "date": "2023-12-29 06:09:30",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "description": "descrição da etiqueta",
    "color": "#000000",
    "access_token": "TAG_TOKEN"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/tags/create';

$payload = [
    'name' => 'VIP',
    'description' => 'Clientes especiais',
    'color' => '#FF9900',
];

$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/tags/create' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"VIP","description":"Clientes especiais","color":"#FF9900"}'