フォームを送信 POST
レスポンスを送信します。送信内容はオーナーのアカウントにメッセージとして届き、スマホにプッシュ通知されます。これは Webhook 呼び出しと同じパイプラインを通ります。認証は不要です。
エンドポイント
POST https://api.pocketalert.app/v1/forms/{tid}/submit認証
不要
リンクを知っている人なら誰でも送信できます。誰が送信できるかはオーナーが管理します。詳しくは 許可するオリジン と以下の制限をご覧ください。
リクエスト
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
tid | string | ✅ | フォームの識別子 |
ボディパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
values | object | ✅ | フィールドの id をキーとした回答 |
website | string | ❌ | ハニーポット。空のままにしてください。値が入っているとボットとみなされます |
フィールドの種類ごとの値:
| 種類 | 値 |
|---|---|
text, textarea, email, phone, number, url | 文字列。email、phone、number、url は形式を検証します |
date | 文字列、YYYY-MM-DD |
dropdown, radio | 文字列。フィールドの options のいずれか |
checkboxes | options から選んだ文字列の配列 |
checkbox | 真偽値 |
rating | 数値、1〜5 |
nps | 数値、0〜10 |
hidden | 文字列。通常はページの URL から取得します |
レイアウト用フィールド(heading、paragraph、divider)は値を受け取りません。未知のキーは無視されます。ボディは 64 KB までです。
リクエスト例
bash
curl -X POST "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit" \
-H "Content-Type: application/json" \
-d '{
"values": {
"name": "Jane Doe",
"email": "[email protected]",
"message": "Do you ship to Canada?",
"src": "newsletter"
}
}'javascript
const response = await fetch(
'https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit',
{
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
values: {
name: 'Jane Doe',
email: '[email protected]',
message: 'Do you ship to Canada?'
}
})
}
);
const result = await response.json();
if (response.status === 400) {
// result.fields = { email: "Enter a valid email address" }
console.log(result.fields);
}python
import requests
response = requests.post(
'https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9/submit',
json={
'values': {
'name': 'Jane Doe',
'email': '[email protected]',
'message': 'Do you ship to Canada?',
}
}
)
print(response.status_code, response.json())レスポンス
成功時のレスポンス
200 OK
json
{ "status": "ok" }オーナーには、回答内容をもとに作成されたプッシュ通知が届きます。オーナーのプラン、デバイス、枠などの情報は、送信者には一切公開されません。
入力エラー
400 Bad Request
fields は、フィールドの id と却下理由を対応づけたものです。フォームページでは、この内容が各入力欄の下に表示されます。
json
{
"error": "Please check the highlighted fields.",
"fields": {
"email": "Enter a valid email address",
"name": "This field is required"
}
}フォームが終了している場合
410 Gone
json
{
"error": "This form is no longer accepting responses.",
"closed": true
}error には、オーナーが設定した closed_message が入ります。
制限
| 制限 | 値 |
|---|---|
| IP アドレスごと | 1 分あたり 10 件 |
| フォームごと | 1 分あたり 60 件、1 時間あたり 300 件 |
| オーナーの枠 | 送信1件ごとに、オーナーの 1 日の上限から 1 件のメッセージを使用します |
オーナーの 1 日のメッセージ上限を超える送信は、429 ヘッダー付きの Retry-After が返されます。プランについての言及はありません。
エラーレスポンス
| ステータス | 説明 |
|---|---|
400 | ボディが不正、または fields に修正が必要な回答が一覧で示されています |
403 | このサイトからの送信をフォームが受け付けていません。詳しくは 許可するオリジン をご覧ください |
404 | フォームが見つかりません |
410 | フォームは終了しています |
429 | 送信が多すぎるか、オーナーが本日のメッセージ上限に達しています |
500 | フォームの設定に問題があるか、メッセージを作成できませんでした |