Criar campo personalizado
POST
https://app.sendapp.ai/api/contact-fields
Cria um novo campo personalizado para os contactos, com as mesmas regras da página Campos personalizados. O campo é adicionado no fim da lista.
Respostas:
201 Created com o campo criado — 409 se já existir um campo com o mesmo nome (sem distinção entre maiúsculas e minúsculas) — 422 se um dado não for válido (a mensagem indica os tipos válidos).Tipos disponíveis:
input, textarea, number, date, select, multiselect, boolean, url, phone, email, ai. options só tem valor para select e multiselect, ai_prompt só para ai.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
8 · 3 obrigatórios
apikey
obrigatório
A sua API Key (o cabeçalho
X-API-Key também funciona).
name
obrigatório
Nome do campo, até 255 caracteres. Tem de ser único na tua conta: é o nome com que escreves o valor num contacto.
type
obrigatório
Tipo do campo:
input, textarea, number, date, select, multiselect, boolean, url, phone, email ou ai.
options
opcional
Só para
select e multiselect (obrigatório): array de opções, de 1 a 50, únicas, cada uma até 60 caracteres. Também aceita uma string separada por vírgulas.
ai_prompt
opcional
Só para
ai (obrigatório): o que a IA deve extrair das conversas, até 500 caracteres.
show_in_list
opcional
true para o mostrar como coluna na lista de contactos (predefinido false).
visible_to_ai
opcional
true se o assistente de IA pode ler o seu valor (predefinido true).
is_required
opcional
true para o tornar obrigatório no formulário do contacto (predefinido false). Não permitido nos campos
ai.
Precisa de ajuda com a integração? info@sendapp.live