フォームを更新 PUT
フォームのフィールド、デザイン、設定を置き換えます。すべてのフィールドが適用されるため、部分的な更新ではなくフォーム全体を送信してください。
エンドポイント
PUT https://api.pocketalert.app/v1/forms/{tid}認証
必須
リクエストに次のいずれかのヘッダーを含めてください:
リクエスト
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
tid | string | ✅ | フォームの識別子 |
ボディパラメータ
フォームを作成と同じです。省略した項目はデフォルト値にリセットされます。allowed_origins を省略すると一覧が消去され、application_tid を省略するとアプリケーションとの紐付けが解除されます。
現在の状態を送信してください
エディターはフォームを読み込み、必要な箇所を変更してから結果を送信し直します。変更したキーだけを送信するクライアントでは、残りの項目が警告なしに消去されてしまいます。
リクエスト例
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}
)レスポンス
成功時のレスポンス
200 OK
更新後のフォームです。形式はフォームを作成と同じです。
エラー時のレスポンス
| ステータス | 説明 |
|---|---|
400 | バリデーションエラー。error フィールドに問題の内容が記載されています |
401 | 認証エラー。トークンが無効、または指定されていません |
404 | フォームが見つからないか、別のアカウントに属しています |
500 | フォームの更新に失敗しました |