Update Conversation (Beta) — DevRev

Updates the requested conversation.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The ID of the conversation to update.

applies_to_partsobjectOptional

channelsobjectOptional

custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

descriptionstringOptionalformat: "text"

The updated description for the conversation.

groupstringOptionalformat: "id"

The group that the conversation is associated with.

is_frozenbooleanOptional

Whether the conversation is frozen.

is_spambooleanOptional

Whether the conversation is spam.

membersobjectOptional

metadataobjectOptional

owned_byobjectOptional

stageobjectOptional

Updates an object’s stage.

statusstringOptionalformat: "text"

The updated status of the conversation.

tagsobjectOptional

titlestringOptionalformat: "text"

The updated title of the conversation.

user_sessionsobjectOptional

Response

The response for updating a conversation.

conversationobject

1 curl -X POST https://api.devrev.ai/conversations.update \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "id": "id" 6 }'

1 { 2 "conversation": { 3 "id": "id", 4 "members": [ 5 { 6 "type": "dev_user", 7 "id": "id", 8 "display_id": "display_id", 9 "display_name": "display_name", 10 "display_picture": { 11 "id": "id", 12 "display_id": "display_id", 13 "file": { 14 "type": "type", 15 "name": "name", 16 "size": 1 17 } 18 }, 19 "email": "email", 20 "full_name": "full_name", 21 "state": "active" 22 }, 23 { 24 "type": "dev_user", 25 "id": "id", 26 "display_id": "display_id", 27 "display_name": "display_name", 28 "display_picture": { 29 "id": "id", 30 "display_id": "display_id", 31 "file": { 32 "type": "type", 33 "name": "name", 34 "size": 1 35 } 36 }, 37 "email": "email", 38 "full_name": "full_name", 39 "state": "active" 40 } 41 ], 42 "actual_close_date": "actual_close_date", 43 "channels": [ 44 { 45 "id": "id", 46 "display_id": "display_id" 47 }, 48 { 49 "id": "id", 50 "display_id": "display_id" 51 } 52 ], 53 "created_by": { 54 "type": "dev_user", 55 "id": "id", 56 "display_id": "display_id", 57 "display_name": "display_name", 58 "display_picture": { 59 "id": "id", 60 "display_id": "display_id", 61 "file": {} 62 }, 63 "email": "email", 64 "full_name": "full_name", 65 "state": "active" 66 }, 67 "created_date": "created_date", 68 "custom_fields": {}, 69 "custom_schema_fragments": [ 70 "custom_schema_fragments", 71 "custom_schema_fragments" 72 ], 73 "description": "description", 74 "display_id": "display_id", 75 "group": { 76 "id": "id", 77 "display_id": "display_id", 78 "member_type": "dev_user", 79 "name": "name", 80 "sync_metadata": { 81 "external_reference": "external_reference", 82 "origin_system": "origin_system" 83 } 84 }, 85 "messages": [ 86 { 87 "type": "timeline_change_event", 88 "id": "id", 89 "object": "object", 90 "object_display_id": "object_display_id", 91 "created_by": { 92 "type": "dev_user" 93 }, 94 "created_date": "created_date", 95 "display_id": "display_id", 96 "event": { 97 "type": "annotated", 98 "created": { 99 "object": { 100 "type": "account" 101 } 102 }, 103 "deleted": { 104 "object_id": "object_id" 105 }, 106 "linked": {}, 107 "updated": { 108 "field_deltas": [], 109 "object_type": "object_type" 110 } 111 }, 112 "external_ref": "external_ref", 113 "labels": [ 114 "labels", 115 "labels" 116 ], 117 "modified_by": { 118 "type": "dev_user" 119 }, 120 "modified_date": "modified_date", 121 "object_type": "account", 122 "panels": [ 123 "alerts", 124 "alerts" 125 ], 126 "reactions": [ 127 { 128 "emoji": "emoji", 129 "reacted": true, 130 "total_users": 1 131 }, 132 { 133 "emoji": "emoji", 134 "reacted": true, 135 "total_users": 1 136 } 137 ], 138 "sync_metadata": { 139 "external_reference": "external_reference", 140 "last_sync_in": {}, 141 "last_sync_out": {}, 142 "origin_system": "origin_system" 143 }, 144 "thread": { 145 "total_replies": 1 146 }, 147 "visibility": "external" 148 }, 149 { 150 "type": "timeline_change_event", 151 "id": "id", 152 "object": "object", 153 "object_display_id": "object_display_id", 154 "created_by": { 155 "type": "dev_user" 156 }, 157 "created_date": "created_date", 158 "display_id": "display_id", 159 "event": { 160 "type": "annotated", 161 "created": { 162 "object": { 163 "type": "account" 164 } 165 }, 166 "deleted": { 167 "object_id": "object_id" 168 }, 169 "linked": {}, 170 "updated": { 171 "field_deltas": [], 172 "object_type": "object_type" 173 } 174 }, 175 "external_ref": "external_ref", 176 "labels": [ 177 "labels", 178 "labels" 179 ], 180 "modified_by": { 181 "type": "dev_user" 182 }, 183 "modified_date": "modified_date", 184 "object_type": "account", 185 "panels": [ 186 "alerts", 187 "alerts" 188 ], 189 "reactions": [ 190 { 191 "emoji": "emoji", 192 "reacted": true, 193 "total_users": 1 194 }, 195 { 196 "emoji": "emoji", 197 "reacted": true, 198 "total_users": 1 199 } 200 ], 201 "sync_metadata": { 202 "external_reference": "external_reference", 203 "last_sync_in": {}, 204 "last_sync_out": {}, 205 "origin_system": "origin_system" 206 }, 207 "thread": { 208 "total_replies": 1 209 }, 210 "visibility": "external" 211 } 212 ], 213 "metadata": { 214 "url_context": "url_context" 215 }, 216 "modified_by": { 217 "type": "dev_user", 218 "id": "id", 219 "display_id": "display_id", 220 "display_name": "display_name", 221 "display_picture": { 222 "id": "id", 223 "display_id": "display_id", 224 "file": {} 225 }, 226 "email": "email", 227 "full_name": "full_name", 228 "state": "active" 229 }, 230 "modified_date": "modified_date", 231 "owned_by": [ 232 { 233 "type": "dev_user", 234 "id": "id", 235 "display_id": "display_id", 236 "display_name": "display_name", 237 "display_picture": { 238 "id": "id", 239 "display_id": "display_id", 240 "file": {} 241 }, 242 "email": "email", 243 "full_name": "full_name", 244 "state": "active" 245 }, 246 { 247 "type": "dev_user", 248 "id": "id", 249 "display_id": "display_id", 250 "display_name": "display_name", 251 "display_picture": { 252 "id": "id", 253 "display_id": "display_id", 254 "file": {} 255 }, 256 "email": "email", 257 "full_name": "full_name", 258 "state": "active" 259 } 260 ], 261 "sla_summary": { 262 "closest_to_breach_metric": "closest_to_breach_metric", 263 "org_schedule": { 264 "id": "id", 265 "status": "archived", 266 "display_id": "display_id", 267 "name": "name", 268 "timezone": "timezone", 269 "valid_until": "valid_until" 270 }, 271 "remaining_time": 1, 272 "sla_tracker": { 273 "id": "id", 274 "metric_target_summaries": [ 275 { 276 "metric_definition": { 277 "id": "id", 278 "name": "name" 279 }, 280 "stage": "stage", 281 "breached_at": "breached_at", 282 "completed_at": "completed_at", 283 "completed_in": 1, 284 "in_policy": true, 285 "is_out_of_schedule": true, 286 "next_schedule_transition": "next_schedule_transition", 287 "org_schedule": { 288 "status": "archived" 289 }, 290 "remaining_time": 1, 291 "status": "status", 292 "target_time": "target_time", 293 "warning_target_time": "warning_target_time" 294 }, 295 { 296 "metric_definition": { 297 "id": "id", 298 "name": "name" 299 }, 300 "stage": "stage", 301 "breached_at": "breached_at", 302 "completed_at": "completed_at", 303 "completed_in": 1, 304 "in_policy": true, 305 "is_out_of_schedule": true, 306 "next_schedule_transition": "next_schedule_transition", 307 "org_schedule": { 308 "status": "archived" 309 }, 310 "remaining_time": 1, 311 "status": "status", 312 "target_time": "target_time", 313 "warning_target_time": "warning_target_time" 314 } 315 ], 316 "applies_to_id": "applies_to_id", 317 "applies_to_type": "conversation", 318 "created_by": { 319 "type": "dev_user" 320 }, 321 "created_date": "created_date", 322 "display_id": "display_id", 323 "modified_by": { 324 "type": "dev_user" 325 }, 326 "modified_date": "modified_date", 327 "removed_sla_metric_history": [ 328 { 329 "metric_definition": {}, 330 "removed_at": "removed_at", 331 "removed_by": { 332 "type": "dev_user" 333 } 334 }, 335 { 336 "metric_definition": {}, 337 "removed_at": "removed_at", 338 "removed_by": { 339 "type": "dev_user" 340 } 341 } 342 ], 343 "sla": { 344 "id": "id", 345 "name": "name", 346 "status": "archived", 347 "display_id": "display_id", 348 "sla_type": "external" 349 }, 350 "sla_policy_id": "sla_policy_id", 351 "stage": "stage", 352 "status": "status" 353 }, 354 "stage": "breached", 355 "target_time": "target_time" 356 }, 357 "sla_tracker": { 358 "id": "id", 359 "applies_to_type": "conversation", 360 "display_id": "display_id" 361 }, 362 "stage": { 363 "name": "name", 364 "notes": "notes", 365 "ordinal": 1, 366 "stage": { 367 "id": "id", 368 "display_id": "display_id", 369 "name": "name" 370 }, 371 "state": { 372 "id": "id", 373 "display_id": "display_id", 374 "is_final": true, 375 "name": "name" 376 } 377 }, 378 "stock_schema_fragment": "stock_schema_fragment", 379 "subtype": "subtype", 380 "sync_metadata": { 381 "external_reference": "external_reference", 382 "last_sync_in": { 383 "status": "failed", 384 "sync_date": "sync_date", 385 "sync_unit": { 386 "id": "id", 387 "display_id": "display_id", 388 "external_system_type": "adaas", 389 "is_archived": true, 390 "name": "name", 391 "sync_run": {}, 392 "sync_type": "manual" 393 } 394 }, 395 "last_sync_out": { 396 "status": "failed", 397 "sync_date": "sync_date", 398 "sync_unit": { 399 "id": "id", 400 "display_id": "display_id", 401 "external_system_type": "adaas", 402 "is_archived": true, 403 "name": "name", 404 "sync_run": {}, 405 "sync_type": "manual" 406 } 407 }, 408 "origin_system": "origin_system" 409 }, 410 "tags": [ 411 { 412 "tag": { 413 "id": "id", 414 "name": "name", 415 "display_id": "display_id", 416 "style_new": { 417 "color": "color" 418 } 419 }, 420 "value": "value" 421 }, 422 { 423 "tag": { 424 "id": "id", 425 "name": "name", 426 "display_id": "display_id", 427 "style_new": { 428 "color": "color" 429 } 430 }, 431 "value": "value" 432 } 433 ], 434 "title": "title" 435 } 436 }

1	curl -X POST https://api.devrev.ai/conversations.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "id"
6	}'

1	{
2	"conversation": {
3	"id": "id",
4	"members": [
5	{
6	"type": "dev_user",
7	"id": "id",
8	"display_id": "display_id",
9	"display_name": "display_name",
10	"display_picture": {
11	"id": "id",
12	"display_id": "display_id",
13	"file": {
14	"type": "type",
15	"name": "name",
16	"size": 1
17	}
18	},
19	"email": "email",
20	"full_name": "full_name",
21	"state": "active"
22	},
23	{
24	"type": "dev_user",
25	"id": "id",
26	"display_id": "display_id",
27	"display_name": "display_name",
28	"display_picture": {
29	"id": "id",
30	"display_id": "display_id",
31	"file": {
32	"type": "type",
33	"name": "name",
34	"size": 1
35	}
36	},
37	"email": "email",
38	"full_name": "full_name",
39	"state": "active"
40	}
41	],
42	"actual_close_date": "actual_close_date",
43	"channels": [
44	{
45	"id": "id",
46	"display_id": "display_id"
47	},
48	{
49	"id": "id",
50	"display_id": "display_id"
51	}
52	],
53	"created_by": {
54	"type": "dev_user",
55	"id": "id",
56	"display_id": "display_id",
57	"display_name": "display_name",
58	"display_picture": {
59	"id": "id",
60	"display_id": "display_id",
61	"file": {}
62	},
63	"email": "email",
64	"full_name": "full_name",
65	"state": "active"
66	},
67	"created_date": "created_date",
68	"custom_fields": {},
69	"custom_schema_fragments": [
70	"custom_schema_fragments",
71	"custom_schema_fragments"
72	],
73	"description": "description",
74	"display_id": "display_id",
75	"group": {
76	"id": "id",
77	"display_id": "display_id",
78	"member_type": "dev_user",
79	"name": "name",
80	"sync_metadata": {
81	"external_reference": "external_reference",
82	"origin_system": "origin_system"
83	}
84	},
85	"messages": [
86	{
87	"type": "timeline_change_event",
88	"id": "id",
89	"object": "object",
90	"object_display_id": "object_display_id",
91	"created_by": {
92	"type": "dev_user"
93	},
94	"created_date": "created_date",
95	"display_id": "display_id",
96	"event": {
97	"type": "annotated",
98	"created": {
99	"object": {
100	"type": "account"
101	}
102	},
103	"deleted": {
104	"object_id": "object_id"
105	},
106	"linked": {},
107	"updated": {
108	"field_deltas": [],
109	"object_type": "object_type"
110	}
111	},
112	"external_ref": "external_ref",
113	"labels": [
114	"labels",
115	"labels"
116	],
117	"modified_by": {
118	"type": "dev_user"
119	},
120	"modified_date": "modified_date",
121	"object_type": "account",
122	"panels": [
123	"alerts",
124	"alerts"
125	],
126	"reactions": [
127	{
128	"emoji": "emoji",
129	"reacted": true,
130	"total_users": 1
131	},
132	{
133	"emoji": "emoji",
134	"reacted": true,
135	"total_users": 1
136	}
137	],
138	"sync_metadata": {
139	"external_reference": "external_reference",
140	"last_sync_in": {},
141	"last_sync_out": {},
142	"origin_system": "origin_system"
143	},
144	"thread": {
145	"total_replies": 1
146	},
147	"visibility": "external"
148	},
149	{
150	"type": "timeline_change_event",
151	"id": "id",
152	"object": "object",
153	"object_display_id": "object_display_id",
154	"created_by": {
155	"type": "dev_user"
156	},
157	"created_date": "created_date",
158	"display_id": "display_id",
159	"event": {
160	"type": "annotated",
161	"created": {
162	"object": {
163	"type": "account"
164	}
165	},
166	"deleted": {
167	"object_id": "object_id"
168	},
169	"linked": {},
170	"updated": {
171	"field_deltas": [],
172	"object_type": "object_type"
173	}
174	},
175	"external_ref": "external_ref",
176	"labels": [
177	"labels",
178	"labels"
179	],
180	"modified_by": {
181	"type": "dev_user"
182	},
183	"modified_date": "modified_date",
184	"object_type": "account",
185	"panels": [
186	"alerts",
187	"alerts"
188	],
189	"reactions": [
190	{
191	"emoji": "emoji",
192	"reacted": true,
193	"total_users": 1
194	},
195	{
196	"emoji": "emoji",
197	"reacted": true,
198	"total_users": 1
199	}
200	],
201	"sync_metadata": {
202	"external_reference": "external_reference",
203	"last_sync_in": {},
204	"last_sync_out": {},
205	"origin_system": "origin_system"
206	},
207	"thread": {
208	"total_replies": 1
209	},
210	"visibility": "external"
211	}
212	],
213	"metadata": {
214	"url_context": "url_context"
215	},
216	"modified_by": {
217	"type": "dev_user",
218	"id": "id",
219	"display_id": "display_id",
220	"display_name": "display_name",
221	"display_picture": {
222	"id": "id",
223	"display_id": "display_id",
224	"file": {}
225	},
226	"email": "email",
227	"full_name": "full_name",
228	"state": "active"
229	},
230	"modified_date": "modified_date",
231	"owned_by": [
232	{
233	"type": "dev_user",
234	"id": "id",
235	"display_id": "display_id",
236	"display_name": "display_name",
237	"display_picture": {
238	"id": "id",
239	"display_id": "display_id",
240	"file": {}
241	},
242	"email": "email",
243	"full_name": "full_name",
244	"state": "active"
245	},
246	{
247	"type": "dev_user",
248	"id": "id",
249	"display_id": "display_id",
250	"display_name": "display_name",
251	"display_picture": {
252	"id": "id",
253	"display_id": "display_id",
254	"file": {}
255	},
256	"email": "email",
257	"full_name": "full_name",
258	"state": "active"
259	}
260	],
261	"sla_summary": {
262	"closest_to_breach_metric": "closest_to_breach_metric",
263	"org_schedule": {
264	"id": "id",
265	"status": "archived",
266	"display_id": "display_id",
267	"name": "name",
268	"timezone": "timezone",
269	"valid_until": "valid_until"
270	},
271	"remaining_time": 1,
272	"sla_tracker": {
273	"id": "id",
274	"metric_target_summaries": [
275	{
276	"metric_definition": {
277	"id": "id",
278	"name": "name"
279	},
280	"stage": "stage",
281	"breached_at": "breached_at",
282	"completed_at": "completed_at",
283	"completed_in": 1,
284	"in_policy": true,
285	"is_out_of_schedule": true,
286	"next_schedule_transition": "next_schedule_transition",
287	"org_schedule": {
288	"status": "archived"
289	},
290	"remaining_time": 1,
291	"status": "status",
292	"target_time": "target_time",
293	"warning_target_time": "warning_target_time"
294	},
295	{
296	"metric_definition": {
297	"id": "id",
298	"name": "name"
299	},
300	"stage": "stage",
301	"breached_at": "breached_at",
302	"completed_at": "completed_at",
303	"completed_in": 1,
304	"in_policy": true,
305	"is_out_of_schedule": true,
306	"next_schedule_transition": "next_schedule_transition",
307	"org_schedule": {
308	"status": "archived"
309	},
310	"remaining_time": 1,
311	"status": "status",
312	"target_time": "target_time",
313	"warning_target_time": "warning_target_time"
314	}
315	],
316	"applies_to_id": "applies_to_id",
317	"applies_to_type": "conversation",
318	"created_by": {
319	"type": "dev_user"
320	},
321	"created_date": "created_date",
322	"display_id": "display_id",
323	"modified_by": {
324	"type": "dev_user"
325	},
326	"modified_date": "modified_date",
327	"removed_sla_metric_history": [
328	{
329	"metric_definition": {},
330	"removed_at": "removed_at",
331	"removed_by": {
332	"type": "dev_user"
333	}
334	},
335	{
336	"metric_definition": {},
337	"removed_at": "removed_at",
338	"removed_by": {
339	"type": "dev_user"
340	}
341	}
342	],
343	"sla": {
344	"id": "id",
345	"name": "name",
346	"status": "archived",
347	"display_id": "display_id",
348	"sla_type": "external"
349	},
350	"sla_policy_id": "sla_policy_id",
351	"stage": "stage",
352	"status": "status"
353	},
354	"stage": "breached",
355	"target_time": "target_time"
356	},
357	"sla_tracker": {
358	"id": "id",
359	"applies_to_type": "conversation",
360	"display_id": "display_id"
361	},
362	"stage": {
363	"name": "name",
364	"notes": "notes",
365	"ordinal": 1,
366	"stage": {
367	"id": "id",
368	"display_id": "display_id",
369	"name": "name"
370	},
371	"state": {
372	"id": "id",
373	"display_id": "display_id",
374	"is_final": true,
375	"name": "name"
376	}
377	},
378	"stock_schema_fragment": "stock_schema_fragment",
379	"subtype": "subtype",
380	"sync_metadata": {
381	"external_reference": "external_reference",
382	"last_sync_in": {
383	"status": "failed",
384	"sync_date": "sync_date",
385	"sync_unit": {
386	"id": "id",
387	"display_id": "display_id",
388	"external_system_type": "adaas",
389	"is_archived": true,
390	"name": "name",
391	"sync_run": {},
392	"sync_type": "manual"
393	}
394	},
395	"last_sync_out": {
396	"status": "failed",
397	"sync_date": "sync_date",
398	"sync_unit": {
399	"id": "id",
400	"display_id": "display_id",
401	"external_system_type": "adaas",
402	"is_archived": true,
403	"name": "name",
404	"sync_run": {},
405	"sync_type": "manual"
406	}
407	},
408	"origin_system": "origin_system"
409	},
410	"tags": [
411	{
412	"tag": {
413	"id": "id",
414	"name": "name",
415	"display_id": "display_id",
416	"style_new": {
417	"color": "color"
418	}
419	},
420	"value": "value"
421	},
422	{
423	"tag": {
424	"id": "id",
425	"name": "name",
426	"display_id": "display_id",
427	"style_new": {
428	"color": "color"
429	}
430	},
431	"value": "value"
432	}
433	],
434	"title": "title"
435	}
436	}