Langsung ke konten

Create Form POST ​

Buat formulir yang di-hosting. Formulir langsung dipublikasikan di https://frms.click/{tid}, dan setiap pengiriman menjadi pesan di akun Anda — lihat Forms.

Endpoint ​

POST https://api.pocketalert.app/v1/forms

Autentikasi ​

Wajib

Sertakan salah satu header berikut dalam permintaan Anda:

  • Token: <your-api-key> — Dapatkan dari API Keys
  • Authorization: Bearer <jwt-token> — Dari Login

Permintaan ​

HeaderWajibDeskripsi
Token✅Kunci API Anda
Authorization✅Bearer <jwt-token>

Parameter Body ​

ParameterTipeWajibDeskripsi
namestring✅Nama internal, hingga 191 karakter. Juga menjadi judul push notification default
fieldsarray✅Kolom formulir, maksimal 30. Setidaknya satu harus berupa kolom yang diisi pengunjung
settingsobject❌Judul, teks, dan desain. Setiap kunci memiliki nilai default
application_tidstring❌Aplikasi tempat pengiriman tersebut masuk
device_tidstring❌TID perangkat tujuan, atau all. Hilangkan untuk semua perangkat
default_levelint❌Level prioritas (-2..2) untuk pengiriman. Lihat Tingkat prioritas pesan
push_titlestring❌Templat judul push notification dengan token {Field label}, hingga 191 karakter
allowed_originsarray❌Host yang boleh menyematkan dan mengirim formulir, maksimal 10. Kosong berarti di mana saja
max_responsesint❌Tutup formulir setelah sejumlah respons ini. 0 (default) berarti tidak terbatas
closes_atstring❌Waktu penutupan, RFC 3339. Disimpan dalam UTC
is_activeboolean❌false langsung menutup formulir. Defaultnya true

Kolom ​

Setiap entri dalam fields:

ParameterTipeWajibDeskripsi
idstring✅Unik dalam formulir: huruf, angka, _ dan -, hingga 40 karakter
typestring✅Salah satu tipe di bawah
labelstring✅Ditampilkan di atas input, hingga 200 karakter (2000 untuk paragraph)
placeholderstring❌Hanya untuk text, textarea, email, phone, number, url, dan dropdown
requiredboolean❌Diabaikan oleh kolom tata letak
optionsarray✅ untuk kolom pilihanHingga 50 entri untuk dropdown, radio, dan checkboxes
paramstring✅ untuk hiddenParameter URL tempat nilai dibaca, misalnya utm_source
GrupTipeNilai yang dikirim
Tekstext, textarea, email, phone, number, url, dateString. text dibatasi 1000 karakter, textarea 5000
Pilihandropdown, radioSalah satu dari options
PilihancheckboxesArray dari options
PilihancheckboxBoolean, ditampilkan sebagai Yes / No
Penilaianrating (1–5), nps (0–10)Angka
Tata letakheading, paragraph, dividerTidak pernah dikirim
PelacakanhiddenDiambil dari URL halaman, bukan dari pengunjung

Nilai email, phone, number, URL, dan date divalidasi di server; pengecekan di browser hanya untuk kenyamanan, bukan pengaman utama.

Pengaturan ​

Semua kunci bersifat opsional — apa pun yang tidak Anda isi akan memakai nilai default.

ParameterTipeDefaultDeskripsi
titlestring""Judul di atas formulir, hingga 200 karakter
top_textstring""Teks pengantar, hingga 2000 karakter. Teks biasa; tautan akan bisa diklik
bottom_textstring""Teks di bawah tombol, hingga 2000 karakter
success_messagestringThanks! Your response has been sent.Ditampilkan setelah pengiriman, hingga 500 karakter
closed_messagestringThis form is no longer accepting responses.Ditampilkan saat formulir ditutup
background_colorstring#f5f5f4Latar belakang halaman, #rrggbb
card_colorstring#ffffffLatar belakang formulir
text_colorstring#1c1917Warna teks
primary_colorstring#3f5cadWarna aksen dan, kecuali ditimpa, tombol
font_familystringInterGoogle Font berdasarkan nama
font_sizeint1612–24
font_weightint400300, 400, 500, 600, atau 700
border_radiusint100–48
hide_brandingbooleanfalseMenyembunyikan tautan "Powered by Pocket Alert". Hanya untuk paket berbayar — pada paket gratis API mengatur ulang nilainya menjadi false
submitobject—{ "text": "Submit", "color": "", "size": "md" }. size adalah sm, md, atau lg; color yang kosong mengikuti primary_color

Templat Judul Push ​

push_title membentuk judul notifikasi dari jawaban:

New lead: {Name} ({Email})

Token merujuk ke kolom berdasarkan label, tidak peka huruf besar-kecil, plus {form} untuk nama formulir. Token tanpa jawaban akan dihilangkan; jika tidak ada yang tersisa, judul kembali ke Form: {name}. Templat ini tidak pernah ditampilkan di halaman publik.

Allowed Origins ​

ID formulir ikut dalam tautan publiknya, sehingga secara default siapa pun yang memilikinya dapat menyematkan formulir. allowed_origins membatasi hal itu: hanya host yang terdaftar yang boleh menampilkan formulir, dan pengiriman dengan Origin (atau Referer) yang tidak ada dalam daftar akan ditolak dengan 403.

Tulis host, bukan URL: example.com, app.example.com, *.example.com untuk semua subdomain, localhost:3000 saat pengembangan. www. diabaikan.

Contoh Permintaan ​

bash
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"
    }
  }'
javascript
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}`);
python
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']}")
php
$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'];

Respons ​

Respons Sukses ​

201 Created

Formulir sudah aktif. Bagikan https://frms.click/{tid}, atau sematkan — lihat Forms.

Isinya memiliki bentuk yang sama dengan satu entri dari Get All Forms.

json
{
  "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"
}

Respons Error ​

StatusDeskripsi
400Error validasi — field error menunjukkan kolom atau pengaturan mana yang salah
401Tidak sah — token tidak valid atau tidak ada
403Anda telah mencapai jumlah formulir yang diizinkan paket Anda
500Gagal membuat formulir

Dokumentasi Pocket Alert