Buscar campo pelo nome

GET/accounts/custom_fields/name/{custom_field_name}

Gerada do contrato OpenAPI

Encontra um campo personalizado pelo nome e devolve o ID, o tipo e a descrição. O nome vai no caminho, codificado para URL: data de nascimento vira data%20de%20nascimento.

Requisição

curl "https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

const resposta = await fetch('https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade', {
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
  },
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.get(
    "https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
    ],
]);
$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.

Parâmetros de caminho

custom_field_namestringobrigatório

O nome do campo, codificado para URL.

Respostas

200Sucesso

O campo.

idinteger

O ID do campo.

namestring

O nome do campo.

typeinteger

O tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não, 5 texto longo, 6 seleção única, 7 seleção múltipla.

descriptionstring

A descrição do campo.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

const resposta = await fetch('https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade', { headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, }, }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.get( "https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/accounts/custom_fields/name/cidade'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), ], ]); $dados = json_decode(curl_exec($ch), true); echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL; print_r($dados);

Autenticação

Parâmetros de caminho

Respostas

Relacionados

Contatos, fluxos e outros identificadores

Limites, erros e boas práticas

Campos personalizados, campos do bot e variáveis

Etiquetar contatos e preencher campos

Listar campos personalizados

Criar campo personalizado