SIsignalshq
DOCUMENT

Set the party on several documents at once

Assigns one party across a selection. The allowed roles are the INTERSECTION across the selected document types, so picking a W-2 alongside a 1099-INT drops Joint from the menu rather than failing on one row. Returns per-document applied/skipped with reasons so the UI can disclose what it did NOT do — silently assigning 9 of 12 is a correctness bug the CPA cannot see.

patch/internal/api/document/party/bulk

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

Request body

client_idstring uuid required

Client ID for the documents

document_idsstring[] required

Documents to assign

party_rolestring nullable required

TAXPAYER | SPOUSE | JOINT, or null to clear.

Response

Successful Response

applied_countinteger required
skipped_countinteger required

Example response

{
  "outcomes": [
    {
      "reason": "FORM_5498 does not permit JOINT"
    }
  ]
}

Changes

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