Login Cadastre-se

Alterar etiqueta

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

Altere etiquetas criadas anteriormente.

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

access_token

Token da etiqueta que deseja alterar.

Sim

String

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.

Não

String 

{
  "access_token": "TAG_TOKEN",
  "name": "VIP+",
  "color": "#00AAFF"
}
Response do request

Em caso de sucesso, retorna HTTP 200 com success true. Se name ou access_token não forem informados, 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 400. Se nenhuma etiqueta 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

tag

Dados da etiqueta alterada.

name: (String) Nome da etiqueta.

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 alterada com sucesso.",
  "tag": {
    "name": "Testando criação de etiqueta pela API",
    "description": "descrição da etiqueta",
    "color": "#000000",
    "access_token": "TAG_TOKEN"
  }
}
 
<?php
$apiKey = 'SEU_API_KEY';
$url = 'https://croncrm.com/api/v2/tags/change';

$payload = [
    'access_token' => 'TAG_TOKEN',
    'name' => 'VIP+',
    'color' => '#00AAFF',
];

$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/tags/change' \
  -H 'apiKey: SEU_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"access_token":"TAG_TOKEN","name":"VIP+","color":"#00AAFF"}'