Update Work

POST

Updates a work item’s information.

Request

This endpoint expects an object.

Issue

None

Opportunity

Task

Ticket

Response

Success.

workobject

POST

1 curl -X POST https://api.devrev.ai/works.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "type": "issue",
6   "artifacts": {},
7   "custom_schema_spec": {},
8   "developed_with": {},
9   "id": "id",
10   "owned_by": {},
11   "priority": "p0",
12   "reported_by": {},
13   "stage": {},
14   "staged_info": {},
15   "tags": {}
16 }'

200Successful

1 {
2   "work": {
3     "type": "issue",
4     "applies_to_part": {
5       "type": "capability",
6       "id": "id",
7       "name": "name",
8       "owned_by": [
9         {
10           "type": "dev_user",
11           "display_picture": {
12             "file": {},
13             "id": "id"
14           },
15           "id": "id",
16           "state": "active",
17           "display_id": "display_id",
18           "display_name": "display_name",
19           "email": "email",
20           "full_name": "full_name"
21         },
22         {
23           "type": "dev_user",
24           "display_picture": {
25             "file": {},
26             "id": "id"
27           },
28           "id": "id",
29           "state": "active",
30           "display_id": "display_id",
31           "display_name": "display_name",
32           "email": "email",
33           "full_name": "full_name"
34         }
35       ],
36       "sync_metadata": {
37         "external_reference": "external_reference",
38         "origin_system": "origin_system"
39       },
40       "display_id": "display_id"
41     },
42     "created_by": {
43       "type": "dev_user",
44       "display_picture": {
45         "file": {
46           "type": "type",
47           "name": "name"
48         },
49         "id": "id",
50         "display_id": "display_id"
51       },
52       "id": "id",
53       "state": "active",
54       "display_id": "display_id",
55       "display_name": "display_name",
56       "email": "email",
57       "full_name": "full_name"
58     },
59     "id": "id",
60     "modified_by": {
61       "type": "dev_user",
62       "display_picture": {
63         "file": {
64           "type": "type",
65           "name": "name"
66         },
67         "id": "id",
68         "display_id": "display_id"
69       },
70       "id": "id",
71       "state": "active",
72       "display_id": "display_id",
73       "display_name": "display_name",
74       "email": "email",
75       "full_name": "full_name"
76     },
77     "owned_by": [
78       {
79         "type": "dev_user",
80         "display_picture": {
81           "file": {
82             "type": "type",
83             "name": "name"
84           },
85           "id": "id",
86           "display_id": "display_id"
87         },
88         "id": "id",
89         "state": "active",
90         "display_id": "display_id",
91         "display_name": "display_name",
92         "email": "email",
93         "full_name": "full_name"
94       },
95       {
96         "type": "dev_user",
97         "display_picture": {
98           "file": {
99             "type": "type",
100             "name": "name"
101           },
102           "id": "id",
103           "display_id": "display_id"
104         },
105         "id": "id",
106         "state": "active",
107         "display_id": "display_id",
108         "display_name": "display_name",
109         "email": "email",
110         "full_name": "full_name"
111       }
112     ],
113     "priority": "p0",
114     "priority_v2": {
115       "id": 1000000,
116       "label": "label",
117       "ordinal": 1000000
118     },
119     "sla_summary": {
120       "org_schedule": {
121         "id": "id",
122         "status": "archived",
123         "display_id": "display_id",
124         "name": "name",
125         "timezone": "timezone",
126         "valid_until": "valid_until"
127       },
128       "sla_tracker": {
129         "applies_to_type": "conversation",
130         "created_by": {
131           "type": "dev_user",
132           "display_picture": {
133             "file": {
134               "type": "type",
135               "name": "name"
136             },
137             "id": "id",
138             "display_id": "display_id"
139           },
140           "id": "id",
141           "state": "active",
142           "display_id": "display_id",
143           "display_name": "display_name",
144           "email": "email",
145           "full_name": "full_name"
146         },
147         "id": "id",
148         "metric_target_summaries": [
149           {
150             "metric_definition": {
151               "id": "id",
152               "display_id": "display_id",
153               "name": "name"
154             },
155             "org_schedule": {
156               "id": "id",
157               "status": "archived",
158               "display_id": "display_id",
159               "name": "name",
160               "timezone": "timezone",
161               "valid_until": "valid_until"
162             },
163             "stage": "stage",
164             "breached_at": "breached_at",
165             "completed_at": "completed_at",
166             "completed_in": 1,
167             "is_out_of_schedule": true,
168             "next_schedule_transition": "next_schedule_transition",
169             "remaining_time": 1,
170             "status": "status",
171             "target_time": "target_time",
172             "warning_target_time": "warning_target_time"
173           },
174           {
175             "metric_definition": {
176               "id": "id",
177               "display_id": "display_id",
178               "name": "name"
179             },
180             "org_schedule": {
181               "id": "id",
182               "status": "archived",
183               "display_id": "display_id",
184               "name": "name",
185               "timezone": "timezone",
186               "valid_until": "valid_until"
187             },
188             "stage": "stage",
189             "breached_at": "breached_at",
190             "completed_at": "completed_at",
191             "completed_in": 1,
192             "is_out_of_schedule": true,
193             "next_schedule_transition": "next_schedule_transition",
194             "remaining_time": 1,
195             "status": "status",
196             "target_time": "target_time",
197             "warning_target_time": "warning_target_time"
198           }
199         ],
200         "modified_by": {
201           "type": "dev_user",
202           "display_picture": {
203             "file": {
204               "type": "type",
205               "name": "name"
206             },
207             "id": "id",
208             "display_id": "display_id"
209           },
210           "id": "id",
211           "state": "active",
212           "display_id": "display_id",
213           "display_name": "display_name",
214           "email": "email",
215           "full_name": "full_name"
216         },
217         "sla": {
218           "id": "id",
219           "name": "name",
220           "sla_type": "external",
221           "status": "archived",
222           "display_id": "display_id"
223         },
224         "applies_to_id": "applies_to_id",
225         "created_date": "created_date",
226         "display_id": "display_id",
227         "modified_date": "modified_date",
228         "removed_sla_metric_history": [
229           {
230             "metric_definition": {
231               "id": "id",
232               "display_id": "display_id",
233               "name": "name"
234             },
235             "removed_at": "removed_at",
236             "removed_by": {
237               "type": "dev_user",
238               "display_picture": {
239                 "file": {}
240               },
241               "id": "id",
242               "state": "active",
243               "display_name": "display_name",
244               "email": "email",
245               "full_name": "full_name"
246             }
247           },
248           {
249             "metric_definition": {
250               "id": "id",
251               "display_id": "display_id",
252               "name": "name"
253             },
254             "removed_at": "removed_at",
255             "removed_by": {
256               "type": "dev_user",
257               "display_picture": {
258                 "file": {}
259               },
260               "id": "id",
261               "state": "active",
262               "display_name": "display_name",
263               "email": "email",
264               "full_name": "full_name"
265             }
266           }
267         ],
268         "sla_policy_id": "sla_policy_id",
269         "stage": "stage",
270         "status": "status"
271       },
272       "stage": "breached",
273       "closest_to_breach_metric": "closest_to_breach_metric",
274       "remaining_time": 1,
275       "target_time": "target_time"
276     },
277     "sla_tracker": {
278       "applies_to_type": "conversation",
279       "id": "id",
280       "display_id": "display_id"
281     },
282     "sprint": {
283       "type": "curated",
284       "id": "id",
285       "name": "name",
286       "state": "active",
287       "end_date": "end_date",
288       "start_date": "start_date"
289     },
290     "stage": {
291       "name": "name",
292       "stage": {
293         "id": "id",
294         "display_id": "display_id",
295         "name": "name"
296       },
297       "state": {
298         "id": "id",
299         "display_id": "display_id",
300         "is_final": true,
301         "name": "name"
302       },
303       "notes": "notes",
304       "ordinal": 1
305     },
306     "sync_metadata": {
307       "last_sync_in": {
308         "status": "failed",
309         "sync_unit": {
310           "external_system_type": "adaas",
311           "id": "id",
312           "sync_run": {
313             "mode": "initial",
314             "progress": {
315               "state": "completed"
316             }
317           },
318           "sync_type": "manual",
319           "display_id": "display_id",
320           "is_archived": true,
321           "name": "name"
322         },
323         "sync_date": "sync_date"
324       },
325       "last_sync_out": {
326         "status": "failed",
327         "sync_unit": {
328           "external_system_type": "adaas",
329           "id": "id",
330           "sync_run": {
331             "mode": "initial",
332             "progress": {
333               "state": "completed"
334             }
335           },
336           "sync_type": "manual",
337           "display_id": "display_id",
338           "is_archived": true,
339           "name": "name"
340         },
341         "sync_date": "sync_date"
342       },
343       "external_reference": "external_reference",
344       "origin_system": "origin_system"
345     },
346     "title": "title",
347     "actual_close_date": "actual_close_date",
348     "actual_start_date": "actual_start_date",
349     "artifacts": [
350       {
351         "file": {
352           "type": "type",
353           "name": "name"
354         },
355         "id": "id",
356         "display_id": "display_id"
357       },
358       {
359         "file": {
360           "type": "type",
361           "name": "name"
362         },
363         "id": "id",
364         "display_id": "display_id"
365       }
366     ],
367     "body": "body",
368     "created_date": "created_date",
369     "custom_fields": {},
370     "custom_schema_fragments": [
371       "custom_schema_fragments",
372       "custom_schema_fragments"
373     ],
374     "developed_with": [
375       {
376         "type": "capability",
377         "id": "id",
378         "name": "name",
379         "owned_by": [
380           {
381             "type": "dev_user",
382             "display_picture": {
383               "file": {}
384             },
385             "id": "id",
386             "state": "active",
387             "display_name": "display_name",
388             "email": "email",
389             "full_name": "full_name"
390           },
391           {
392             "type": "dev_user",
393             "display_picture": {
394               "file": {}
395             },
396             "id": "id",
397             "state": "active",
398             "display_name": "display_name",
399             "email": "email",
400             "full_name": "full_name"
401           }
402         ],
403         "sync_metadata": {
404           "external_reference": "external_reference",
405           "origin_system": "origin_system"
406         },
407         "display_id": "display_id"
408       },
409       {
410         "type": "capability",
411         "id": "id",
412         "name": "name",
413         "owned_by": [
414           {
415             "type": "dev_user",
416             "display_picture": {
417               "file": {}
418             },
419             "id": "id",
420             "state": "active",
421             "display_name": "display_name",
422             "email": "email",
423             "full_name": "full_name"
424           },
425           {
426             "type": "dev_user",
427             "display_picture": {
428               "file": {}
429             },
430             "id": "id",
431             "state": "active",
432             "display_name": "display_name",
433             "email": "email",
434             "full_name": "full_name"
435           }
436         ],
437         "sync_metadata": {
438           "external_reference": "external_reference",
439           "origin_system": "origin_system"
440         },
441         "display_id": "display_id"
442       }
443     ],
444     "display_id": "display_id",
445     "modified_date": "modified_date",
446     "reported_by": [
447       {
448         "type": "dev_user",
449         "display_picture": {
450           "file": {
451             "type": "type",
452             "name": "name"
453           },
454           "id": "id",
455           "display_id": "display_id"
456         },
457         "id": "id",
458         "state": "active",
459         "display_id": "display_id",
460         "display_name": "display_name",
461         "email": "email",
462         "full_name": "full_name"
463       },
464       {
465         "type": "dev_user",
466         "display_picture": {
467           "file": {
468             "type": "type",
469             "name": "name"
470           },
471           "id": "id",
472           "display_id": "display_id"
473         },
474         "id": "id",
475         "state": "active",
476         "display_id": "display_id",
477         "display_name": "display_name",
478         "email": "email",
479         "full_name": "full_name"
480       }
481     ],
482     "stock_schema_fragment": "stock_schema_fragment",
483     "subtype": "subtype",
484     "tags": [
485       {
486         "tag": {
487           "id": "id",
488           "name": "name",
489           "style_new": {
490             "color": "color"
491           },
492           "display_id": "display_id"
493         },
494         "value": "value"
495       },
496       {
497         "tag": {
498           "id": "id",
499           "name": "name",
500           "style_new": {
501             "color": "color"
502           },
503           "display_id": "display_id"
504         },
505         "value": "value"
506       }
507     ],
508     "target_close_date": "target_close_date",
509     "target_start_date": "target_start_date"
510   }
511 }

Changelog

Up Next

Built with

1	curl -X POST https://api.devrev.ai/works.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "issue",
6	"artifacts": {},
7	"custom_schema_spec": {},
8	"developed_with": {},
9	"id": "id",
10	"owned_by": {},
11	"priority": "p0",
12	"reported_by": {},
13	"stage": {},
14	"staged_info": {},
15	"tags": {}
16	}'

1	{
2	"work": {
3	"type": "issue",
4	"applies_to_part": {
5	"type": "capability",
6	"id": "id",
7	"name": "name",
8	"owned_by": [
9	{
10	"type": "dev_user",
11	"display_picture": {
12	"file": {},
13	"id": "id"
14	},
15	"id": "id",
16	"state": "active",
17	"display_id": "display_id",
18	"display_name": "display_name",
19	"email": "email",
20	"full_name": "full_name"
21	},
22	{
23	"type": "dev_user",
24	"display_picture": {
25	"file": {},
26	"id": "id"
27	},
28	"id": "id",
29	"state": "active",
30	"display_id": "display_id",
31	"display_name": "display_name",
32	"email": "email",
33	"full_name": "full_name"
34	}
35	],
36	"sync_metadata": {
37	"external_reference": "external_reference",
38	"origin_system": "origin_system"
39	},
40	"display_id": "display_id"
41	},
42	"created_by": {
43	"type": "dev_user",
44	"display_picture": {
45	"file": {
46	"type": "type",
47	"name": "name"
48	},
49	"id": "id",
50	"display_id": "display_id"
51	},
52	"id": "id",
53	"state": "active",
54	"display_id": "display_id",
55	"display_name": "display_name",
56	"email": "email",
57	"full_name": "full_name"
58	},
59	"id": "id",
60	"modified_by": {
61	"type": "dev_user",
62	"display_picture": {
63	"file": {
64	"type": "type",
65	"name": "name"
66	},
67	"id": "id",
68	"display_id": "display_id"
69	},
70	"id": "id",
71	"state": "active",
72	"display_id": "display_id",
73	"display_name": "display_name",
74	"email": "email",
75	"full_name": "full_name"
76	},
77	"owned_by": [
78	{
79	"type": "dev_user",
80	"display_picture": {
81	"file": {
82	"type": "type",
83	"name": "name"
84	},
85	"id": "id",
86	"display_id": "display_id"
87	},
88	"id": "id",
89	"state": "active",
90	"display_id": "display_id",
91	"display_name": "display_name",
92	"email": "email",
93	"full_name": "full_name"
94	},
95	{
96	"type": "dev_user",
97	"display_picture": {
98	"file": {
99	"type": "type",
100	"name": "name"
101	},
102	"id": "id",
103	"display_id": "display_id"
104	},
105	"id": "id",
106	"state": "active",
107	"display_id": "display_id",
108	"display_name": "display_name",
109	"email": "email",
110	"full_name": "full_name"
111	}
112	],
113	"priority": "p0",
114	"priority_v2": {
115	"id": 1000000,
116	"label": "label",
117	"ordinal": 1000000
118	},
119	"sla_summary": {
120	"org_schedule": {
121	"id": "id",
122	"status": "archived",
123	"display_id": "display_id",
124	"name": "name",
125	"timezone": "timezone",
126	"valid_until": "valid_until"
127	},
128	"sla_tracker": {
129	"applies_to_type": "conversation",
130	"created_by": {
131	"type": "dev_user",
132	"display_picture": {
133	"file": {
134	"type": "type",
135	"name": "name"
136	},
137	"id": "id",
138	"display_id": "display_id"
139	},
140	"id": "id",
141	"state": "active",
142	"display_id": "display_id",
143	"display_name": "display_name",
144	"email": "email",
145	"full_name": "full_name"
146	},
147	"id": "id",
148	"metric_target_summaries": [
149	{
150	"metric_definition": {
151	"id": "id",
152	"display_id": "display_id",
153	"name": "name"
154	},
155	"org_schedule": {
156	"id": "id",
157	"status": "archived",
158	"display_id": "display_id",
159	"name": "name",
160	"timezone": "timezone",
161	"valid_until": "valid_until"
162	},
163	"stage": "stage",
164	"breached_at": "breached_at",
165	"completed_at": "completed_at",
166	"completed_in": 1,
167	"is_out_of_schedule": true,
168	"next_schedule_transition": "next_schedule_transition",
169	"remaining_time": 1,
170	"status": "status",
171	"target_time": "target_time",
172	"warning_target_time": "warning_target_time"
173	},
174	{
175	"metric_definition": {
176	"id": "id",
177	"display_id": "display_id",
178	"name": "name"
179	},
180	"org_schedule": {
181	"id": "id",
182	"status": "archived",
183	"display_id": "display_id",
184	"name": "name",
185	"timezone": "timezone",
186	"valid_until": "valid_until"
187	},
188	"stage": "stage",
189	"breached_at": "breached_at",
190	"completed_at": "completed_at",
191	"completed_in": 1,
192	"is_out_of_schedule": true,
193	"next_schedule_transition": "next_schedule_transition",
194	"remaining_time": 1,
195	"status": "status",
196	"target_time": "target_time",
197	"warning_target_time": "warning_target_time"
198	}
199	],
200	"modified_by": {
201	"type": "dev_user",
202	"display_picture": {
203	"file": {
204	"type": "type",
205	"name": "name"
206	},
207	"id": "id",
208	"display_id": "display_id"
209	},
210	"id": "id",
211	"state": "active",
212	"display_id": "display_id",
213	"display_name": "display_name",
214	"email": "email",
215	"full_name": "full_name"
216	},
217	"sla": {
218	"id": "id",
219	"name": "name",
220	"sla_type": "external",
221	"status": "archived",
222	"display_id": "display_id"
223	},
224	"applies_to_id": "applies_to_id",
225	"created_date": "created_date",
226	"display_id": "display_id",
227	"modified_date": "modified_date",
228	"removed_sla_metric_history": [
229	{
230	"metric_definition": {
231	"id": "id",
232	"display_id": "display_id",
233	"name": "name"
234	},
235	"removed_at": "removed_at",
236	"removed_by": {
237	"type": "dev_user",
238	"display_picture": {
239	"file": {}
240	},
241	"id": "id",
242	"state": "active",
243	"display_name": "display_name",
244	"email": "email",
245	"full_name": "full_name"
246	}
247	},
248	{
249	"metric_definition": {
250	"id": "id",
251	"display_id": "display_id",
252	"name": "name"
253	},
254	"removed_at": "removed_at",
255	"removed_by": {
256	"type": "dev_user",
257	"display_picture": {
258	"file": {}
259	},
260	"id": "id",
261	"state": "active",
262	"display_name": "display_name",
263	"email": "email",
264	"full_name": "full_name"
265	}
266	}
267	],
268	"sla_policy_id": "sla_policy_id",
269	"stage": "stage",
270	"status": "status"
271	},
272	"stage": "breached",
273	"closest_to_breach_metric": "closest_to_breach_metric",
274	"remaining_time": 1,
275	"target_time": "target_time"
276	},
277	"sla_tracker": {
278	"applies_to_type": "conversation",
279	"id": "id",
280	"display_id": "display_id"
281	},
282	"sprint": {
283	"type": "curated",
284	"id": "id",
285	"name": "name",
286	"state": "active",
287	"end_date": "end_date",
288	"start_date": "start_date"
289	},
290	"stage": {
291	"name": "name",
292	"stage": {
293	"id": "id",
294	"display_id": "display_id",
295	"name": "name"
296	},
297	"state": {
298	"id": "id",
299	"display_id": "display_id",
300	"is_final": true,
301	"name": "name"
302	},
303	"notes": "notes",
304	"ordinal": 1
305	},
306	"sync_metadata": {
307	"last_sync_in": {
308	"status": "failed",
309	"sync_unit": {
310	"external_system_type": "adaas",
311	"id": "id",
312	"sync_run": {
313	"mode": "initial",
314	"progress": {
315	"state": "completed"
316	}
317	},
318	"sync_type": "manual",
319	"display_id": "display_id",
320	"is_archived": true,
321	"name": "name"
322	},
323	"sync_date": "sync_date"
324	},
325	"last_sync_out": {
326	"status": "failed",
327	"sync_unit": {
328	"external_system_type": "adaas",
329	"id": "id",
330	"sync_run": {
331	"mode": "initial",
332	"progress": {
333	"state": "completed"
334	}
335	},
336	"sync_type": "manual",
337	"display_id": "display_id",
338	"is_archived": true,
339	"name": "name"
340	},
341	"sync_date": "sync_date"
342	},
343	"external_reference": "external_reference",
344	"origin_system": "origin_system"
345	},
346	"title": "title",
347	"actual_close_date": "actual_close_date",
348	"actual_start_date": "actual_start_date",
349	"artifacts": [
350	{
351	"file": {
352	"type": "type",
353	"name": "name"
354	},
355	"id": "id",
356	"display_id": "display_id"
357	},
358	{
359	"file": {
360	"type": "type",
361	"name": "name"
362	},
363	"id": "id",
364	"display_id": "display_id"
365	}
366	],
367	"body": "body",
368	"created_date": "created_date",
369	"custom_fields": {},
370	"custom_schema_fragments": [
371	"custom_schema_fragments",
372	"custom_schema_fragments"
373	],
374	"developed_with": [
375	{
376	"type": "capability",
377	"id": "id",
378	"name": "name",
379	"owned_by": [
380	{
381	"type": "dev_user",
382	"display_picture": {
383	"file": {}
384	},
385	"id": "id",
386	"state": "active",
387	"display_name": "display_name",
388	"email": "email",
389	"full_name": "full_name"
390	},
391	{
392	"type": "dev_user",
393	"display_picture": {
394	"file": {}
395	},
396	"id": "id",
397	"state": "active",
398	"display_name": "display_name",
399	"email": "email",
400	"full_name": "full_name"
401	}
402	],
403	"sync_metadata": {
404	"external_reference": "external_reference",
405	"origin_system": "origin_system"
406	},
407	"display_id": "display_id"
408	},
409	{
410	"type": "capability",
411	"id": "id",
412	"name": "name",
413	"owned_by": [
414	{
415	"type": "dev_user",
416	"display_picture": {
417	"file": {}
418	},
419	"id": "id",
420	"state": "active",
421	"display_name": "display_name",
422	"email": "email",
423	"full_name": "full_name"
424	},
425	{
426	"type": "dev_user",
427	"display_picture": {
428	"file": {}
429	},
430	"id": "id",
431	"state": "active",
432	"display_name": "display_name",
433	"email": "email",
434	"full_name": "full_name"
435	}
436	],
437	"sync_metadata": {
438	"external_reference": "external_reference",
439	"origin_system": "origin_system"
440	},
441	"display_id": "display_id"
442	}
443	],
444	"display_id": "display_id",
445	"modified_date": "modified_date",
446	"reported_by": [
447	{
448	"type": "dev_user",
449	"display_picture": {
450	"file": {
451	"type": "type",
452	"name": "name"
453	},
454	"id": "id",
455	"display_id": "display_id"
456	},
457	"id": "id",
458	"state": "active",
459	"display_id": "display_id",
460	"display_name": "display_name",
461	"email": "email",
462	"full_name": "full_name"
463	},
464	{
465	"type": "dev_user",
466	"display_picture": {
467	"file": {
468	"type": "type",
469	"name": "name"
470	},
471	"id": "id",
472	"display_id": "display_id"
473	},
474	"id": "id",
475	"state": "active",
476	"display_id": "display_id",
477	"display_name": "display_name",
478	"email": "email",
479	"full_name": "full_name"
480	}
481	],
482	"stock_schema_fragment": "stock_schema_fragment",
483	"subtype": "subtype",
484	"tags": [
485	{
486	"tag": {
487	"id": "id",
488	"name": "name",
489	"style_new": {
490	"color": "color"
491	},
492	"display_id": "display_id"
493	},
494	"value": "value"
495	},
496	{
497	"tag": {
498	"id": "id",
499	"name": "name",
500	"style_new": {
501	"color": "color"
502	},
503	"display_id": "display_id"
504	},
505	"value": "value"
506	}
507	],
508	"target_close_date": "target_close_date",
509	"target_start_date": "target_start_date"
510	}
511	}