End Users

Update end user Bill Navigator status

The Bill Navigator end user status API allows you to update the status of an end user's account.

put/end_users/{end_user_id}/bill_navigator/status

Request

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

Path parameters

end_user_idstring required

User ID provided by you, to associate Pinwheel users with your user model.

Headers

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.

Request body

action'deactivate' | 'terminate' | 'deactivated' | 'terminated' required

The action to take on the end user's account. Valid actions are deactivated and terminated. When an end user is set to deactivated, the user can reactivate themselves. When an end user is set to terminated, the action is irreversible.

reasonstring

The reason for taking action on the end user's account.

Response

No Content

Changes

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