FieldEdge Open API
production
  • production
  • dev
DocsAPIs
DocsAPIs
production
  • production
  • dev
production
  • production
  • dev
  1. Assignments
  • Lead
    • Creates a new lead with customer details, appointment preferences, and service information.
      POST
    • Fetches lead details based on the provided lead identifier.
      GET
  • Customer
    • Creates a new customer
      POST
    • Updates an existing customer
      PUT
    • Retrieve customer by phone number
      GET
    • Search customers with optional filters
      GET
    • Retrieve customers based on address details.
      GET
    • Retrieve customer details by ID
      GET
  • CustomerAttachments
    • Upload a file attachment to a customer record
      POST
    • Retrieve attachments for a customer
      GET
  • CustomerNotes
    • Create a note on a customer record
      POST
    • Retrieve all notes for a customer
      GET
    • Update an existing customer note
      PATCH
  • CustomerTags
    • Associate a tag with a customer
      POST
    • Remove a tag from a customer
      DELETE
    • Create a reusable customer tag
      POST
    • Retrieve tags
      GET
  • Item
    • Creates a new inventory item
      POST
    • Retrieve a paginated list of inventory items with optional filters
      GET
    • Bulk update inventory items
      PATCH
    • Updates an existing inventory item
      PATCH
    • Retrieve an inventory item by ID
      GET
  • ItemCategory
    • Retrieve list of item categories
    • Create a new item category
    • Retrieve item category by id.
    • Partially update an item category
  • SalesTaxCode
    • Retrieve list of sales tax codes
  • WorkOrder
    • Retrieve a paginated list of work orders
    • Retrieve a work order by ID
    • Retrieve work orders at a given address, most recent first
    • Create a new work order
    • Update an existing work order
    • Retrieve list of business units
    • Retrieve business unit by id.
    • Retrieve list of lead sources
    • Retrieve lead source by id.
  • Assignments
    • Retrieve all technician assignments for a work order
      GET
    • Assign a technician to a work order
      POST
    • Update a technician assignment's status
      PATCH
    • Remove a technician from a work order assignment
      DELETE
  • Agreement
    • Retrieve list of agreements
    • Retrieve agreement by id.
  • Invoice
    • Retrieve a paginated list of invoices
    • Retrieve an invoice by ID
    • Create or update the invoice on a work order
  • Quote
    • Retrieve a paginated list of quotes
    • Retrieve a quote by ID
  • Task
    • Retrieve a task bundle by ID
    • Retrieve a list of tasks
  • Warehouse
    • Create a new warehouse
    • Retrieve a paginated list of warehouses
    • Update an existing warehouse
    • Retrieve a warehouse by ID
  • Employee
    • Retrieve a paginated list of employees
    • Retrieve an employee by ID
  • Company
    • Retrieve company name by ID
  • Webhook
    • Register a webhook endpoint to receive event notifications.
    • Delete the registered webhook for the authenticated account.
    • Rotate the HMAC signing secret for the registered webhook.
  1. Assignments

Update a technician assignment's status

PATCH
/v1/work-orders/{workOrderId}/assignments/{assignmentId}/status
Changes a technician assignment's status (pending, traveling, working, paused, completed, canceled). Triggers the same customer notifications, live dispatch-board updates, and geofence sync as a status change made directly on the dispatch board. Does not reassign the technician. Canceling requires cancelNote. Fails once the assignment is already completed, canceled, or finalized. The change is timestamped with the current server time; there is no field to backdate or schedule it.
Required scope: workorders:write

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Status updated successfully.
Bodyapplication/json

🟠400
🟠401
🟠403
🟠404
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request PATCH 'https://api.fieldedge.com/open-api/v1/work-orders//assignments//status' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "status": "working"
}'
Response Response Example
200 - Sample response returned after changing an assignment's status
{
    "data": {
        "workOrderId": "3f2e1d4c-5b6a-4978-8f1e-0a9b8c7d6e5f",
        "assignmentId": "9f1a6b1c-3a3e-4b91-9a2f-2c6a9fbb1234",
        "status": "working"
    }
}
Modified at 2026-09-11 09:13:15
Previous
Assign a technician to a work order
Next
Remove a technician from a work order assignment
Built with