Перейти к содержимому

Обновление формы PUT ​

Заменяет поля, оформление и настройки формы. Применяется каждое поле, поэтому отправляйте всю форму целиком, а не только изменения.

Эндпоинт ​

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

Аутентификация ​

Обязательно

Добавьте в запрос один из этих заголовков:

  • Token: <your-api-key> — получите его в разделе API-ключи
  • Authorization: Bearer <jwt-token> — из входа

Запрос ​

Параметры пути ​

ПараметрТипОбязательныйОписание
tidstring✅Идентификатор формы

Параметры тела запроса ​

Такие же, как в создании формы. Всё, что вы не передали, сбрасывается к значению по умолчанию: если не передать 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Не удалось обновить форму

Документация Pocket Alert