Add or preview client watches
POST
/client-watchesRequires scope: write:watch
Parameters
| Parameter | In | Type | Description |
|---|---|---|---|
Idempotency-Keyrequired | header | string | Stable logical request ID required for every machine mutation; exact retries replay and changed inputs conflict. |
Request body
| Field | Type | Allowed values | Description |
|---|---|---|---|
storesrequired | object[] | any object[] | |
preview | boolean | any boolean |
Responses
| Status | Description |
|---|---|
200 | Known client-watch result |
400 | Invalid stores, mode, period, range, cursor, or limit |
401 | Missing or invalid watch credential |
403 | Credential lacks the required watch scope or a human principal |
404 | Client Watch is unavailable, the account is not visible, or no stored brief exists |
409 | Client Watch is not offered, cannot be funded, or cannot be settled safely |
503 | Watch authorization or client-watch data is unavailable |
Is this page helpful?