Aller au contenu

Mettre à jour un formulaire PUT ​

Remplacez les champs, le design et les paramètres d’un formulaire. Chaque champ est appliqué : envoyez donc le formulaire complet, et non un correctif partiel.

Point de terminaison ​

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

Authentification ​

Obligatoire

Incluez l’un de ces en-têtes dans votre requête :

  • Token: <your-api-key> — Obtenez-la depuis Clés API
  • Authorization: Bearer <jwt-token> — Depuis Se connecter

Requête ​

Paramètres de chemin ​

ParamètreTypeObligatoireDescription
tidstring✅Identifiant du formulaire

Paramètres du corps ​

Identiques à ceux de Créer un formulaire. Tout ce que vous omettez est réinitialisé à sa valeur par défaut : omettre allowed_origins vide la liste, et omettre application_tid détache l’application.

Envoyez l’état actuel

L’éditeur charge le formulaire, modifie ce dont il a besoin et renvoie le résultat. Un client qui n’envoie que les clés modifiées effacera silencieusement le reste.

Exemple de requête ​

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

Réponse ​

Réponse de succès ​

200 OK

Le formulaire mis à jour, dans le même format que Créer un formulaire.

Réponses d’erreur ​

StatutDescription
400Erreur de validation — le champ error indique le problème
401Non autorisé — jeton absent ou invalide
404Formulaire introuvable, ou appartenant à un autre compte
500Échec de la mise à jour du formulaire

Documentation de Pocket Alert