Update Conversation — DevRev

Updates the requested conversation.

Request

This endpoint expects an object.

applies_to_partsobjectRequired

custom_schema_specobjectRequired

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

idstringRequiredformat: "id"

The ID of the conversation to update.

membersobjectRequired

metadataobjectRequired

owned_byobjectRequired

stageobjectRequired

Updates an object’s stage.

tagsobjectRequired

user_sessionsobjectRequired

custom_fieldsobjectOptional

Application-defined custom fields.

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.

statusstringOptionalformat: "text"

The updated status of the conversation.

titlestringOptionalformat: "text"

The updated title of the conversation.

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 "applies_to_parts": {}, 6 "custom_schema_spec": {}, 7 "id": "id", 8 "members": {}, 9 "metadata": {}, 10 "owned_by": {}, 11 "stage": {}, 12 "tags": {}, 13 "user_sessions": {} 14 }'

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

1	curl -X POST https://api.devrev.ai/conversations.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"applies_to_parts": {},
6	"custom_schema_spec": {},
7	"id": "id",
8	"members": {},
9	"metadata": {},
10	"owned_by": {},
11	"stage": {},
12	"tags": {},
13	"user_sessions": {}
14	}'

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