Preencher campo do contato

POST/contacts/{contact_id}/custom_fields/{custom_field_id}

Gerada do contrato OpenAPI

Grava um valor num campo personalizado do contato, como a ação Definir Campo Personalizado de um fluxo. O valor vai em formulário, no formato do tipo do campo: data e data e hora em Unix timestamp (segundos) e sim/não como 1 ou 0. Para preencher pelo nome do campo no lugar do ID, mande a ação set_field_value em Enviar conteúdo. Veja Etiquetar contatos e preencher campos.

Requisição

curl -X POST "https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  --data-urlencode 'value=São Paulo'

const resposta = await fetch('https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001', {
  method: 'POST',
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
  },
  body: new URLSearchParams({
    value: 'São Paulo',
  }),
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.post(
    "https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    data={
        "value": "São Paulo",
    },
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
    ],
    CURLOPT_POSTFIELDS => http_build_query([
        'value' => 'São Paulo',
    ]),
]);
$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

contact_idintegerobrigatório

O ID do contato.

custom_field_idstringobrigatório

O ID do campo personalizado.

Corpo da requisição

FormulárioContent-Type: application/x-www-form-urlencoded

valuestringobrigatório

O valor, no formato do tipo do campo.

Exemplo: São Paulo

Respostas

200Sucesso

O valor foi gravado.

successboolean

true quando o valor foi gravado.

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/contacts/123456789/custom_fields/3001', { method: 'POST', headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, }, body: new URLSearchParams({ value: 'São Paulo', }), }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.post( "https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, data={ "value": "São Paulo", }, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789/custom_fields/3001'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), ], CURLOPT_POSTFIELDS => http_build_query([ 'value' => 'São Paulo', ]), ]); $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

Corpo da requisição

Respostas

Relacionados

Visão geral da API

Campos personalizados, campos do bot e variáveis

Criar ou atualizar um contato

Etiquetar contatos e preencher campos

Listar campos personalizados

Criar campo personalizado