Criar campo personalizado
/accounts/custom_fieldsCria um campo personalizado na conta e devolve o ID dele. Pela API, o tipo vai de 0 a 4 (texto, número, data, data e hora e sim/não); texto longo e seleções se criam no app. Com isBotField: true, o campo nasce como campo do bot, com um valor só para a conta toda, que vai em value. Use um nome novo: no app, um nome repetido ou reservado é recusado.
curl -X POST "https://app.nextagsai.com.br/api/accounts/custom_fields" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "cidade",
"type": 0,
"description": "Cidade de entrega"
}'const resposta = await fetch('https://app.nextagsai.com.br/api/accounts/custom_fields', {
method: 'POST',
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'cidade',
type: 0,
description: 'Cidade de entrega',
}),
});
const dados = await resposta.json();
console.log(resposta.status, dados);import os
import requests
resposta = requests.post(
"https://app.nextagsai.com.br/api/accounts/custom_fields",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
json={
"name": "cidade",
"type": 0,
"description": "Cidade de entrega",
},
timeout=30,
)
print(resposta.status_code, resposta.json())<?php
$ch = curl_init('https://app.nextagsai.com.br/api/accounts/custom_fields');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'name' => 'cidade',
'type' => 0,
'description' => 'Cidade de entrega',
]),
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);Autenticação
Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.
Corpo da requisição
JSONContent-Type: application/json
namestringobrigatórioO nome do campo, como ele aparece nas listas e nas variáveis das mensagens ({{cidade}}).
Exemplo: cidade
typeintegerobrigatórioO tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não. Depois de criado, o campo não muda de tipo.
Valores: 0 1 2 3 4
isBotFieldbooleantrue cria um campo do bot (um valor para a conta toda) no lugar de um campo do contato.
Padrão: false
valuestringO valor do campo do bot, no formato do tipo. Num campo do contato, é ignorado.
descriptionstringUma descrição, que aparece embaixo do nome na lista de campos.
Exemplo: Cidade de entrega
Respostas
O campo criado.
idintegerO ID do campo novo.
namestringO nome do campo.
A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.
Relacionados
Contatos, fluxos e outros identificadores
Guia que usa este endpointCampos personalizados, campos do bot e variáveis
Guia que usa este endpointCriar campos personalizados
Tutorial da Central de AjudaListar campos personalizados
GET /accounts/custom_fieldsConsultar campo personalizado
GET /accounts/custom_fields/{custom_field_id}Buscar campo pelo nome
GET /accounts/custom_fields/name/{custom_field_name}Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.