Langsung ke konten

Perbarui Formulir PUT ​

Ganti kolom, desain, dan pengaturan formulir. Setiap kolom akan diterapkan, jadi kirim seluruh formulir, bukan patch.

Endpoint ​

PUT https://api.pocketalert.app/v1/forms/{tid}

Autentikasi ​

Wajib

Sertakan salah satu header berikut dalam permintaan Anda:

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

Permintaan ​

Parameter Path ​

ParameterTipeWajibDeskripsi
tidstring✅Identifier formulir

Parameter Body ​

Sama seperti Buat Formulir. Apa pun yang Anda tinggalkan akan direset ke nilai default: menghilangkan allowed_origins akan mengosongkan daftar, dan menghilangkan application_tid akan melepas aplikasi.

Kirim status terkini

Editor memuat formulir, mengubah bagian yang diperlukan, lalu mengirim hasilnya kembali. Klien yang hanya mengirim kunci yang berubah akan diam-diam menghapus sisanya.

Contoh Permintaan ​

bash
curl -X PUT "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9" \
  -H "Token: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Contact form",
    "is_active": false,
    "max_responses": 100,
    "allowed_origins": ["example.com", "*.shop.example.com"],
    "fields": [
      { "id": "name", "type": "text", "label": "Name", "required": true },
      { "id": "email", "type": "email", "label": "Email", "required": true }
    ],
    "settings": { "title": "Get in touch" }
  }'
javascript
const tid = 'vml19aihrga216gt8apc5e3m9';

// Load the form, change one thing, send it all back.
const [form] = await fetch('https://api.pocketalert.app/v1/forms', {
  headers: { 'Token': 'your-api-key' }
}).then((r) => r.json()).then((forms) => forms.filter((f) => f.tid === tid));

await fetch(`https://api.pocketalert.app/v1/forms/${tid}`, {
  method: 'PUT',
  headers: {
    'Token': 'your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ ...form, is_active: false })
});
python
import requests

tid = 'vml19aihrga216gt8apc5e3m9'
headers = {'Token': 'your-api-key'}

forms = requests.get('https://api.pocketalert.app/v1/forms', headers=headers).json()
form = next(f for f in forms if f['tid'] == tid)

requests.put(
    f'https://api.pocketalert.app/v1/forms/{tid}',
    headers=headers,
    json={**form, 'is_active': False}
)

Respons ​

Respons Sukses ​

200 OK

Formulir yang telah diperbarui, dengan bentuk yang sama seperti Buat Formulir.

Respons Error ​

StatusDeskripsi
400Error validasi — kolom error menjelaskan apa yang salah
401Tidak terotorisasi — Token tidak valid atau tidak ada
404Formulir tidak ditemukan, atau milik akun lain
500Gagal memperbarui formulir

Dokumentasi Pocket Alert