Zum Inhalt springen

Formular aktualisieren PUT ​

Ersetze die Felder, das Design und die Einstellungen eines Formulars. Jedes Feld wird übernommen, also sende das komplette Formular und keinen Teil davon.

Endpunkt ​

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

Authentifizierung ​

Erforderlich

Füge einen dieser Header in deine Anfrage ein:

Anfrage ​

Pfadparameter ​

ParameterTypErforderlichBeschreibung
tidstring✅Formular-Kennung

Body-Parameter ​

Dieselben wie bei Formular erstellen. Alles, was du weglässt, wird auf den Standardwert zurückgesetzt: Lässt du allowed_origins weg, wird die Liste geleert, lässt du application_tid weg, wird die Anwendung entkoppelt.

Aktuellen Stand senden

Der Editor lädt das Formular, ändert, was nötig ist, und sendet das Ergebnis zurück. Ein Client, der nur die geänderten Schlüssel sendet, löscht den Rest stillschweigend.

Beispielanfrage ​

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}
)

Antwort ​

Erfolgreiche Antwort ​

200 OK

Das aktualisierte Formular, im selben Format wie bei Formular erstellen.

Fehlerantworten ​

StatusBeschreibung
400Validierungsfehler — das Feld error beschreibt, was falsch ist
401Nicht autorisiert — Token ungültig oder fehlt
404Formular nicht gefunden oder gehört zu einem anderen Konto
500Formular konnte nicht aktualisiert werden

Pocket Alert Dokumentation