Update Opportunity Work Order | Coperniq

Update an opportunity’s work order. Supports partial updates.

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Updatable fields:

title, description, priority
startDate, endDate, startDateAllDay, endDateAllDay
status (label string)
assigneeId
visits: Only applicable on field work orders. When provided, the visits array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their id), and include new visits without an id. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted.
checklist: Update the checklist for the work order. When this field is provided, the checklist array REPLACES the full set of checklist items on the work order.
- Include every existing item you want to keep or modify (identified by id).
- Any existing item NOT included in this array will be removed.
- Each item MUST include an id. Items without an id are ignored (checklist item creation is not supported).

Update an opportunity's work order. Supports partial updates. **Note:** The `/requests` path is an alias for `/opportunities` and will continue to work until users are individually notified and migrated. Updatable fields: - title, description, priority - startDate, endDate, startDateAllDay, endDateAllDay - status (label string) - assigneeId - visits: Only applicable on field work orders. When provided, the `visits` array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their `id`), and include new visits without an `id`. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted. - checklist: Update the checklist for the work order. When this field is provided, the `checklist` array REPLACES the full set of checklist items on the work order. - Include every existing item you want to keep or modify (identified by `id`). - Any existing item NOT included in this array will be removed. - Each item MUST include an `id`. Items without an `id` are ignored (checklist item creation is not supported).

Authentication

x-api-keystring

API Key authentication via header

Path parameters

opportunityIdstringRequired

Opportunity identifier

workOrderIdstringRequired

Work order identifier

Request

This endpoint expects an object.

titlestringOptional

descriptionstringOptional

priorityintegerOptional

startDatestringOptionalformat: "date-time"

startDateAllDaybooleanOptional

endDatestringOptionalformat: "date-time"

endDateAllDaybooleanOptional

statusstringOptional

Status label

assigneeIdintegerOptional

User identifier to assign to the work order

collaboratorslist of integersOptional

User identifiers to assign as collaborators to the work order

visitslist of objectsOptional

Only applicable on field work orders. When provided, the visits array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their id), and include new visits without an id. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted.

checklistlist of objectsOptional

Update the checklist for the work order. When this field is provided, the checklist array REPLACES the full set of checklist items on the work order.

Include every existing item you want to keep or modify (identified by id).
Any existing item NOT included in this array will be removed.
Each item MUST include an id. Items without an id are ignored (checklist item creation is not supported).

Update the checklist for the work order. When this field is provided, the `checklist` array REPLACES the full set of checklist items on the work order. - Include every existing item you want to keep or modify (identified by `id`). - Any existing item NOT included in this array will be removed. - Each item MUST include an `id`. Items without an `id` are ignored (checklist item creation is not supported).

Response

Work order updated successfully

idinteger or null

Work order identifier

uidinteger or null

Unique work order number within the project

templateIdinteger or null

Template identifier for the work order

createdAtstring or nullformat: "date-time"

Creation timestamp

updatedAtstring or nullformat: "date-time"

Last update timestamp

titlestring or null

Work order title

descriptionstring or null

Work order description

priorityinteger or null

Priority level

startDatestring or nullformat: "date-time"

Scheduled start date

startDateAllDayboolean or null

Whether the start date is an all-day event

endDatestring or nullformat: "date-time"

Scheduled end date

endDateAllDayboolean or null

Whether the end date is an all-day event

completedAtstring or nullformat: "date-time"

Timestamp when the work order was completed

isArchivedboolean or null

Whether the work order is archived

isCompletedboolean or null

Whether the work order is completed

isFieldboolean or null

Whether the work order is a field task

labelslist of objects or null

Labels associated with the work order

projectobject or null

Project associated with the work order

assigneeobject or null

User assigned to the work order

collaboratorslist of objects or null

Additional users collaborating on the work order

visitsobject or null

Site visits associated with the work order (legacy shape)

statuseslist of objects or null

History of status changes and time spent in each status

statusobject or null

Current status of the work order

checklistlist of objects or null

Checklist items for the work order

Errors

Update an opportunity’s work order. Supports partial updates.

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Updatable fields:

title, description, priority
startDate, endDate, startDateAllDay, endDateAllDay
status (label string)
assigneeId
visits: Only applicable on field work orders. When provided, the visits array REPLACES the full set of visits for the work order. Include all existing visits you wish to keep or update (with their id), and include new visits without an id. Any existing visit not included in the request will be removed. Visit booleans default to false when omitted.
checklist: Update the checklist for the work order. When this field is provided, the checklist array REPLACES the full set of checklist items on the work order.
- Include every existing item you want to keep or modify (identified by id).
- Any existing item NOT included in this array will be removed.
- Each item MUST include an id. Items without an id are ignored (checklist item creation is not supported).

1	curl -X PATCH https://api.coperniq.io/v1/opportunities/opportunityId/work-orders/workOrderId \
2	-H "x-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"body": {}
6	}'

1	{
2	"id": 1024,
3	"uid": 58,
4	"templateId": 12,
5	"createdAt": "2024-01-15T09:30:00Z",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"title": "Install HVAC System",
8	"description": "Installation of the new HVAC system in the main office building.",
9	"priority": 2,
10	"startDate": "2024-02-01T08:00:00Z",
11	"startDateAllDay": true,
12	"endDate": "2024-02-05T17:00:00Z",
13	"endDateAllDay": true,
14	"completedAt": "2024-02-06T12:00:00Z",
15	"isArchived": false,
16	"isCompleted": true,
17	"isField": true,
18	"labels": [
19	{
20	"label": {
21	"id": 3,
22	"label": "Urgent",
23	"color": "#FF0000"
24	}
25	}
26	],
27	"project": {
28	"id": 210,
29	"uid": 45,
30	"title": "Main Office Renovation",
31	"address": [
32	"1234 Elm Street",
33	"Suite 500",
34	"Springfield, IL 62704"
35	]
36	},
37	"assignee": {
38	"id": 7,
39	"firstName": "Alice",
40	"lastName": "Johnson",
41	"email": "alice.johnson@example.com"
42	},
43	"collaborators": [
44	{
45	"id": 15,
46	"firstName": "Bob",
47	"lastName": "Smith",
48	"email": "bob.smith@example.com",
49	"avatarUrl": "https://example.com/avatars/bobsmith.jpg"
50	}
51	],
52	"visits": {
53	"visits": [
54	{
55	"id": 301,
56	"description": "Initial site inspection",
57	"startDate": "2024-01-20T09:00:00Z",
58	"endDate": "2024-01-20T11:00:00Z",
59	"startDateAllDay": false,
60	"endDateAllDay": false,
61	"isCompleted": true
62	}
63	]
64	},
65	"statuses": [
66	{
67	"count": "1",
68	"endedAt": "2024-02-06T12:00:00Z",
69	"spentTime": 432000,
70	"startedAt": "2024-02-01T08:00:00Z",
71	"status": "completed"
72	}
73	],
74	"status": {
75	"id": "completed",
76	"label": "Completed"
77	},
78	"checklist": [
79	{
80	"id": 501,
81	"detail": "Verify all HVAC units are installed",
82	"isCompleted": true,
83	"completedAt": "2024-02-05T16:30:00Z"
84	}
85	]
86	}