Criar formulário POST
Crie um formulário hospedado. Ele é publicado na hora em https://frms.click/{tid}, e cada envio vira uma mensagem na sua conta — veja Formulários.
Endpoint
POST https://api.pocketalert.app/v1/formsAutenticação
Obrigatório
Inclua um destes cabeçalhos na sua requisição:
Token: <your-api-key>— Obtenha em Chaves de APIAuthorization: Bearer <jwt-token>— Obtido em Entrar
Requisição
Cabeçalhos
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
Token | ✅ | Sua chave de API |
Authorization | ✅ | Bearer <jwt-token> |
Parâmetros do corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ✅ | Nome interno, até 191 caracteres. Também é o título padrão da notificação push |
fields | array | ✅ | Os campos do formulário, máximo de 30. Pelo menos um deve ser algo que o visitante preenche |
settings | object | ❌ | Título, textos e design. Cada chave tem um valor padrão |
application_tid | string | ❌ | Aplicativo ao qual os envios pertencem |
device_tid | string | ❌ | TID do dispositivo de destino, ou all. Omita para todos os dispositivos |
default_level | int | ❌ | Nível de prioridade (-2..2) para os envios. Veja Níveis de prioridade da mensagem |
push_title | string | ❌ | Modelo do título push com tokens {Field label}, até 191 caracteres |
allowed_origins | array | ❌ | Hosts autorizados a incorporar e enviar o formulário, máximo de 10. Vazio significa qualquer lugar |
max_responses | int | ❌ | Fecha o formulário após este número de respostas. 0 (padrão) é ilimitado |
closes_at | string | ❌ | Horário de encerramento, RFC 3339. Armazenado em UTC |
is_active | boolean | ❌ | false fecha o formulário imediatamente. O padrão é true |
Campos
Cada item em fields:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | ✅ | Único dentro do formulário: letras, dígitos, _ e -, até 40 caracteres |
type | string | ✅ | Um dos tipos abaixo |
label | string | ✅ | Exibido acima do campo, até 200 caracteres (2000 para paragraph) |
placeholder | string | ❌ | Apenas para text, textarea, email, phone, number, url e dropdown |
required | boolean | ❌ | Ignorado em campos de layout |
options | array | ✅ em campos de escolha | Até 50 itens para dropdown, radio e checkboxes |
param | string | ✅ para hidden | Parâmetro da URL de onde o valor é lido, ex.: utm_source |
| Grupo | Tipos | Valor enviado |
|---|---|---|
| Texto | text, textarea, email, phone, number, url, date | String. text é limitado a 1000 caracteres, textarea a 5000 |
| Escolha | dropdown, radio | Um dos options |
| Escolha | checkboxes | Array de options |
| Escolha | checkbox | Booleano, exibido como Yes / No |
| Avaliação | rating (1–5), nps (0–10) | Número |
| Layout | heading, paragraph, divider | Nunca enviado |
| Rastreamento | hidden | Obtido da URL da página, não do visitante |
Valores de e-mail, telefone, número, URL e data são validados no servidor; a verificação no navegador é só uma conveniência, não a proteção.
Configurações
Todas as chaves são opcionais — o que você não informar mantém o padrão.
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
title | string | "" | Título acima do formulário, até 200 caracteres |
top_text | string | "" | Texto de introdução, até 2000 caracteres. Texto simples; links ficam clicáveis |
bottom_text | string | "" | Texto abaixo do botão, até 2000 caracteres |
success_message | string | Thanks! Your response has been sent. | Exibida após um envio, até 500 caracteres |
closed_message | string | This form is no longer accepting responses. | Exibida quando o formulário está fechado |
background_color | string | #f5f5f4 | Fundo da página, #rrggbb |
card_color | string | #ffffff | Fundo do formulário |
text_color | string | #1c1917 | Texto |
primary_color | string | #3f5cad | Destaque e, salvo se substituído, o botão |
font_family | string | Inter | Uma fonte do Google Fonts pelo nome |
font_size | int | 16 | 12–24 |
font_weight | int | 400 | 300, 400, 500, 600 ou 700 |
border_radius | int | 10 | 0–48 |
hide_branding | boolean | false | Oculta o link "Powered by Pocket Alert". Apenas em planos pagos — no plano gratuito a API o redefine para false |
submit | object | — | { "text": "Submit", "color": "", "size": "md" }. size é sm, md ou lg; um color vazio segue primary_color |
Modelo do título push
push_title monta o título da notificação a partir das respostas:
New lead: {Name} ({Email})Os tokens referenciam campos pelo rótulo, sem diferenciar maiúsculas, além de {form} para o nome do formulário. Tokens sem resposta são removidos; se nada sobrar, o título volta para Form: {name}. O modelo nunca é exibido na página pública.
Origens permitidas
O ID do formulário circula no link público, então por padrão qualquer pessoa que o tenha pode incorporar o formulário. allowed_origins impede isso: apenas os hosts listados podem exibir o formulário, e um envio cujo Origin (ou Referer) não esteja na lista é rejeitado com 403.
Informe hosts, não URLs: example.com, app.example.com, *.example.com para todos os subdomínios, localhost:3000 durante o desenvolvimento. O prefixo www. é ignorado.
Exemplo de requisição
curl -X POST "https://api.pocketalert.app/v1/forms" \
-H "Token: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "Contact form",
"push_title": "New lead: {Name}",
"fields": [
{ "id": "name", "type": "text", "label": "Name", "required": true },
{ "id": "email", "type": "email", "label": "Email", "required": true },
{ "id": "message", "type": "textarea", "label": "Message" },
{ "id": "src", "type": "hidden", "label": "Source", "param": "utm_source" }
],
"settings": {
"title": "Get in touch",
"top_text": "We reply within one business day.",
"primary_color": "#3f5cad"
}
}'const response = await fetch('https://api.pocketalert.app/v1/forms', {
method: 'POST',
headers: {
'Token': 'your-api-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Contact form',
push_title: 'New lead: {Name}',
fields: [
{ id: 'name', type: 'text', label: 'Name', required: true },
{ id: 'email', type: 'email', label: 'Email', required: true },
{ id: 'message', type: 'textarea', label: 'Message' }
],
settings: { title: 'Get in touch' }
})
});
const form = await response.json();
console.log('Form link:', `https://frms.click/${form.tid}`);import requests
response = requests.post(
'https://api.pocketalert.app/v1/forms',
headers={'Token': 'your-api-key'},
json={
'name': 'Contact form',
'push_title': 'New lead: {Name}',
'fields': [
{'id': 'name', 'type': 'text', 'label': 'Name', 'required': True},
{'id': 'email', 'type': 'email', 'label': 'Email', 'required': True},
{'id': 'message', 'type': 'textarea', 'label': 'Message'},
],
'settings': {'title': 'Get in touch'},
}
)
form = response.json()
print(f"Form link: https://frms.click/{form['tid']}")$form = Http::withHeaders([
'Token' => 'your-api-key',
])->post('https://api.pocketalert.app/v1/forms', [
'name' => 'Contact form',
'push_title' => 'New lead: {Name}',
'fields' => [
['id' => 'name', 'type' => 'text', 'label' => 'Name', 'required' => true],
['id' => 'email', 'type' => 'email', 'label' => 'Email', 'required' => true],
['id' => 'message', 'type' => 'textarea', 'label' => 'Message'],
],
'settings' => ['title' => 'Get in touch'],
])->json();
echo 'Form link: https://frms.click/'.$form['tid'];Resposta
Resposta de sucesso
201 Created
O formulário está no ar. Compartilhe https://frms.click/{tid}, ou incorpore-o — veja Formulários.
O corpo tem o mesmo formato de um item de Listar todos os formulários.
{
"tid": "vml19aihrga216gt8apc5e3m9",
"name": "Contact form",
"fields": [
{ "id": "name", "type": "text", "label": "Name", "required": true },
{ "id": "email", "type": "email", "label": "Email", "required": true },
{ "id": "message", "type": "textarea", "label": "Message" },
{ "id": "src", "type": "hidden", "label": "Source", "param": "utm_source" }
],
"settings": {
"title": "Get in touch",
"top_text": "We reply within one business day.",
"success_message": "Thanks! Your response has been sent.",
"closed_message": "This form is no longer accepting responses.",
"background_color": "#f5f5f4",
"card_color": "#ffffff",
"text_color": "#1c1917",
"primary_color": "#3f5cad",
"font_family": "Inter",
"font_size": 16,
"font_weight": 400,
"border_radius": 10,
"hide_branding": false,
"submit": { "text": "Submit", "color": "", "size": "md" }
},
"application_tid": "",
"device_tid": "",
"default_level": null,
"push_title": "New lead: {Name}",
"allowed_origins": [],
"max_responses": 0,
"closes_at": null,
"closed": false,
"is_active": true,
"submissions_count": 0,
"last_submission_at": "",
"created_at": "23.09.2026 11:40:02"
}Respostas de erro
| Status | Descrição |
|---|---|
400 | Erro de validação — o campo error indica qual campo ou configuração está incorreto |
401 | Não autorizado — token inválido ou ausente |
403 | Você atingiu o número de formulários permitido pelo seu plano |
500 | Falha ao criar o formulário |