Mark workpaper dirty

Sets workpaper_dirty for this client and tax year. GET workpaper will return status=STALE until the next successful evaluation. Call when document upload or questionnaire data changes.

post/internal/api/clients/{client_id}/workpaper/mark-dirty

Request

Base URL
https://api.signalshq.io (the document declares no server; this is the origin it was published from)
Auth
OAuth 2
Password
Token URL: /auth/login

Path parameters

client_idstring uuid required

Client ID

Request body

tax_yearinteger required

Tax year for the workpaper to mark dirty

Example request

{
  "tax_year": 2025
}

Response

Successful Response

updatedboolean required

True if a tax return was found and workpaper_dirty was set; false if no return.

Changes

No recorded changes to this operation across all 1 revision of this API.