Sandbox

Override an account's monitoring status

Manually override a sandbox account's monitoring status.

patch/sandbox/accounts/{account_id}

Request

Base URL
https://api.getpinwheel.com/v1
Auth
API key in header X-API-SECRET
TypeScript
https://skmtc.dev/getpinwheel/apis/pinwheel/docs/sandbox/accounts/:account_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

account_idstring uuid required

UUID of the payroll account.

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

monitoring_status'user_action_required'

Monitoring status describes the the automated ability of Pinwheel to retrieve new account information.

dataPayrollAccountObjResponse required

No recorded changes to this operation across all 13 revisions of this API.