Changelog
04
/
09
/
26
Enhanced Filing Blocker Management
Payroll
We’re excited to announce new filing blocker management endpoints. You can now manage filing blockers via API, eliminating the dependency on Zendesk tickets for updating the majority of blocker types.
POST /filings/{id}/add_blockerswith theblocker_typeas an array in the body will place a blocker on a filing. In production, onlyheld_by_customeris accepted. In sandbox, other issue types are accepted for testing.POST /filings/{id}/remove_blockerswithblocker_typeas an array in the body will remove a blocker and return the filing to apendingstatus if all blockers are removed. Multiple types can be specified in a single request. Some blockers cannot be manually removed and the endpoint will return a descriptive error explaining why. Read more in our API Guide.
A few reminders to keep in mind:
- We will automatically queue
pendingfilings for refile if the filing isclosed. Each refile attempt will count as adelayed_filingfor billing, so ensure the underlying issue is resolved before removing the blockers. - The
status_historyvalue in the filing object is updated to include all of the blockers in theblocked_reasonarray. It previously only returned the most recently addedblocked_reason. - This release replaces the API call to hold a filing that was previously announced. The
add_blockersandremove_blockersAPIs will take the place of thePOST /filings/{id}/holdandPOST /filings/{id}/release_holdthat was previously proposed. The updatedstatus_historyfunctionality will replace the proposal forhold_history.
These changes are live today in Sandbox and Production.