API Reference

Restart a W-4 case

post
https://services.fountain.com/api/serviceemployment/processes/companies//profiles/w4/workers//restart

Restart the worker's W-4 submission workflow.

Path Params
uuid
required

company unique identifier

uuid
required

worker unique identifier

Body Params
string

restart reason

boolean

Re-enable messaging for the worker if it was disabled

boolean

Re-include the worker in segments if they were excluded

documentAssignmentIds
array of integers
length ≥ 1

W-4 only; refused for the I-9. WorkBright document assignment IDs of the assigned forms to restart (w4Case.assignedForms[].workbrightRefs.documentAssignmentId), at least one. Only these forms are reset; the others keep their submission and completed status. Omit to restart every form.

documentAssignmentIds
Responses
202

Profile successfully restarted. For a W-4 restart that names its forms, data.restartedForms names the forms restarted, and data.refusedForms and data.refusedDocumentAssignmentIds the forms WorkBright refused to reject. A refused form keeps its submission and can be restarted again.

Updated 41 minutes ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 41 minutes ago

Did this page help you?