Atualizar campo personalizado

PUT https://app.sendapp.ai/api/contact-fields/{id}

Altera um campo personalizado. A atualização é parcial: as chaves que não envias ficam como estão. Também aceita PATCH. Os valores já guardados nos contactos mantêm-se.

Também podes mudar o type, com as mesmas regras da criação: ao passar para select/multiselect são precisas as options (se o campo já as tinha, mantêm-se), ao passar para ai é preciso ai_prompt e o campo deixa de ser obrigatório.

Respostas: 200 com o campo e a lista changed das definições alteradas — 404 se o campo não for da tua conta — 409 se o novo nome já for usado por outro campo — 422 se um dado não for válido.

Erros comuns: 401 se a chave API falta ou está errada — 403 se o plano expirou ou não inclui o acesso à API — 429 se fizeres demasiados pedidos em pouco tempo ou se estiver em curso outra alteração aos campos personalizados da tua conta: tenta novamente após alguns segundos.

Parâmetros

9 · 2 obrigatórios

apikey obrigatório

A sua API Key (o cabeçalho X-API-Key também funciona).

id obrigatório

ID do campo (inteiro, no caminho). Usa GET /api/contact-fields para o encontrar.

name opcional

Novo nome (único na tua conta).

type opcional

Tipo do campo: input, textarea, number, date, select, multiselect, boolean, url, phone, email ou ai.

options opcional

A lista completa das novas opções (substitui a atual).

ai_prompt opcional

Novo prompt (campos ai).

show_in_list opcional

true para o mostrar como coluna na lista de contactos, false para o retirar. Se não o enviares, fica como está.

visible_to_ai opcional

true se o assistente de IA pode ler o seu valor, false se não. Se não o enviares, fica como está.

is_required opcional

true para o tornar obrigatório no formulário do contacto, false para o retirar. Se não o enviares, fica como está. Não permitido para os campos ai.

Precisa de ajuda com a integração? info@sendapp.live

curl -X PATCH 'https://app.sendapp.ai/api/contact-fields/13' \ -H 'X-API-Key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "options": ["S", "M", "L", "XL"], "show_in_list": true }'

<?php $ch = curl_init('https://app.sendapp.ai/api/contact-fields/13'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY', 'Content-Type: application/json'], CURLOPT_POSTFIELDS => json_encode(['options' => ['S', 'M', 'L', 'XL'], 'show_in_list' => true]), ]); echo curl_exec($ch); curl_close($ch);

const res = await fetch('https://app.sendapp.ai/api/contact-fields/13', { method: 'PATCH', headers: { 'X-API-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ options: ['S', 'M', 'L', 'XL'], show_in_list: true }) }); console.log(await res.json());

{ "status": "success", "message": "Field updated.", "changed": ["options", "show_in_list"], "field": { "id": 13, "name": "Size", "type": "select", "options": ["S", "M", "L", "XL"], "show_in_list": true, "...": "..." } }