POST residentapi/workorders

Creates a work order

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UnitId	Connect Unit Id.	integer	Required
PropertyId	Connect Property Id. Used when submitted a workorder.	integer	Required
CategoryId	Category Id.	integer	Required
Description	Description.	string	Required
Phone	Work Order Phone. Either phone or email is required.	string	None.
Email	Work Order Email. Either phone or email is required.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "unitId": 1,
  "propertyId": 2,
  "categoryId": 3,
  "description": "sample string 4",
  "phone": "sample string 5",
  "email": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Workorder

Name	Description	Type	Additional information
WorkOrderId	Work Order Id.	integer	None.
UnitId	Connect Unit Id. Used when submitting a workorder (use when no TypeId "Personal")	integer	None.
PropertyId	Connect Property Id. Used when submitted a workorder	integer	None.
CreatedOn	Created On	date	None.
Status	Status. Open or Closed	string	None.
Type	Type. Either 'Personal' or a Common Area Name	string	None.
TypeId	Type Id. Used when submitting a workorder. Use "-1" for "Personal" SEE GET /residentapi/properties/{propertyId:int}/commonareas	integer	None.
Category	Category. SEE GET /residentapi/workordercategories	WorkorderCategory	None.
ProgressCode	Progress Code.	string	None.
ProgressCodeId	Progress Code Id. Used when submitting a workorder. SEE GET /residentapi/progresscodes/workorders	integer	None.
Number	Work Order Number.	integer	None.
Description	Description.	string	None.
AssignedTo	Assigned To.	Collection of string	None.
Photos	Photos. The photos which are attached to the work order	Collection of WorkorderPhoto	None.
Phone	Work Order Phone.	string	None.
Email	Work Order Created by Email.	string	None.
CreatedBy	Created By.	integer	None.
SubmittedByName	Submitted By Name. This will be the Connect user's name or "Submitted by Resident"	string	None.
UnitsData	Units Data	Unit	None.

Response Formats

application/json, text/json

Sample:

{
  "workOrderId": 1,
  "unitId": 1,
  "propertyId": 2,
  "createdOn": "2025-12-24T09:10:23.4324603-05:00",
  "status": "sample string 3",
  "type": "sample string 4",
  "typeId": 1,
  "category": {
    "categoryId": 1,
    "categoryName": "sample string 2"
  },
  "progressCode": "sample string 5",
  "progressCodeId": 1,
  "number": 6,
  "description": "sample string 7",
  "assignedTo": [
    "sample string 1",
    "sample string 2"
  ],
  "photos": [
    {
      "photoId": 1,
      "workorderId": 2,
      "name": "sample string 3",
      "caption": "sample string 4",
      "fileUrl": "sample string 5"
    },
    {
      "photoId": 1,
      "workorderId": 2,
      "name": "sample string 3",
      "caption": "sample string 4",
      "fileUrl": "sample string 5"
    }
  ],
  "phone": "sample string 8",
  "email": "sample string 9",
  "createdBy": 1,
  "submittedByName": "sample string 10",
  "unitsData": {
    "unitId": 1,
    "unitNumber": "sample string 2",
    "address1": "sample string 3",
    "address2": "sample string 4",
    "city": "sample string 5",
    "state": "sample string 6",
    "zip": "sample string 7"
  }
}