Skip to content

API リファレンスの端末数と取り消しの配送先をプラン別の配送に合わせる #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bannzai merged 1 commit into from
Sep 24, 2026
Merged

API リファレンスの端末数と取り消しの配送先をプラン別の配送に合わせる #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ curl -X DELETE https://api.signalarm.app/v1/alarms/3b0e0c6e-9f1b-4c0a-9e7d-1f2a3

`200 OK` with the same body as `POST /v1/alarms`, with `"status": "canceled"`. Cancelling an alarm that was already cancelled returns the same response, so retries are safe.

The cancellation only reaches the devices that are registered when you send the request. If a device was unregistered after the alarm was scheduled, the alarm already on that device is not cancelled and still rings; cancel it from the alarm list in the app.
The cancellation only reaches the devices that receive alarms when you send the request (see Limits below). If a device was unregistered, or stopped receiving alarms because a Pro subscription ended, after the alarm was scheduled, the alarm already on that device is not cancelled and still rings; cancel it from the alarm list in the app.

### Errors

Expand Down Expand Up @@ -125,10 +125,10 @@ Unexpected server failures use `500` with `"code": "internal"`.
| --- | --- | --- |
| Alarms per calendar month (UTC) | 50 | 1000 |
| API tokens | 1 | Multiple (one per system) |
| Devices per account | 20 | 20 |
| Devices that receive alarms | 1 (the first device registered) | All registered devices (up to 20) |
| Alarm history in the app | Last 3 alarms | 30 days |

A plan-specific device limit is not enforced yet; both plans share the same cap of 20 registered devices. Requests are rate limited to 60 per minute per token on both plans. Alarm records (for history and cancellation) are kept for 30 days after the alarm fires or is cancelled.
On the Free plan, alarms go only to the first iPhone registered to the account; iPhones registered after it stay on the account but do not receive alarms. When a Pro subscription ends, delivery goes back to the first registered iPhone. Requests are rate limited to 60 per minute per token on both plans. Alarm records (for history and cancellation) are kept for 30 days after the alarm fires or is cancelled.

## Delivery and timing

Expand Down
Loading