Publish, Route, Assign, and complete work orders.
Once a work order is created, you must move it through its lifecycle using specific API actions.
A work order starts in Draft state. It is invisible to anyone but you. Publishing changes the state to Open (or Routed), making it visible to the providers you route it to.
POST /workorders/{id}/publish
You can also unpublish a work order to return it to Draft state using DELETE /workorders/{id}/publish.
You have two primary ways to fill a work order:
Use Route when you need to find talent or get competitive offers. Use Assign when you have a dedicated W-2 employee or a preferred contractor you've already spoken with.
Routing sends the work order to specific providers or groups, inviting them to request the work.
POST /workorders/{id}/route
{
"technician": { "id": 12345 }
}To route to many providers at once (e.g., a Talent Pool), use the mass-route endpoint.
POST /workorders/{id}/mass-route
{
"talent_pool_id": 9921
}Automatically routes the work order based on pre-defined rules.
POST /workorders/auto_dispatch
When routing, you can apply Selection Rules to filter providers.
{
"selection_rule": {
"rules": [
{ "name": "rating", "operator": ">=", "value": 4.5 }
]
}
}See Assignments for detailed assignment management.
POST /workorders/{id}/assignee
If satisfied with the work, approve to release payment.
POST /workorders/{id}/approve
If unsatisfied, mark it incomplete to send it back.
DELETE /workorders/{id}/complete
Required Params:
reason: Text descriptionreason_id: The ID of the incomplete reasonUse GET /company/{id}/reasons/incomplete to get valid Reason IDs for your company.
| Action | Endpoint | Method |
|---|---|---|
| Publish | /workorders/{id}/publish | POST |
| Unpublish | /workorders/{id}/publish | DELETE |
| Route to provider | /workorders/{id}/route | POST |
| Mass route | /workorders/{id}/mass-route | POST |
| Auto dispatch | /workorders/auto_dispatch | POST |
| Assign | /workorders/{id}/assignee | POST |
| Approve | /workorders/{id}/approve | POST |
| Mark incomplete | /workorders/{id}/complete | DELETE |
Last updated on