Update Conversation — 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 "channels": [ 43 { 44 "id": "id", 45 "display_id": "display_id" 46 }, 47 { 48 "id": "id", 49 "display_id": "display_id" 50 } 51 ], 52 "created_by": { 53 "type": "dev_user", 54 "id": "id", 55 "display_id": "display_id", 56 "display_name": "display_name", 57 "display_picture": { 58 "id": "id", 59 "display_id": "display_id", 60 "file": {} 61 }, 62 "email": "email", 63 "full_name": "full_name", 64 "state": "active" 65 }, 66 "created_date": "created_date", 67 "description": "description", 68 "display_id": "display_id", 69 "group": { 70 "id": "id", 71 "display_id": "display_id" 72 }, 73 "messages": [ 74 { 75 "type": "timeline_comment", 76 "id": "id", 77 "object": "object", 78 "object_display_id": "object_display_id", 79 "artifacts": [ 80 { 81 "id": "id", 82 "display_id": "display_id", 83 "file": {} 84 }, 85 { 86 "id": "id", 87 "display_id": "display_id", 88 "file": {} 89 } 90 ], 91 "body": "body", 92 "body_type": "data", 93 "created_by": { 94 "type": "dev_user" 95 }, 96 "created_date": "created_date", 97 "display_id": "display_id", 98 "modified_by": { 99 "type": "dev_user" 100 }, 101 "modified_date": "modified_date", 102 "object_type": "capability", 103 "snap_kit_body": { 104 "body": {}, 105 "snap_in_action_name": "snap_in_action_name", 106 "snap_in_id": "snap_in_id" 107 }, 108 "snap_widget_body": [ 109 { 110 "type": "type" 111 }, 112 { 113 "type": "type" 114 } 115 ], 116 "visibility": "external" 117 }, 118 { 119 "type": "timeline_comment", 120 "id": "id", 121 "object": "object", 122 "object_display_id": "object_display_id", 123 "artifacts": [ 124 { 125 "id": "id", 126 "display_id": "display_id", 127 "file": {} 128 }, 129 { 130 "id": "id", 131 "display_id": "display_id", 132 "file": {} 133 } 134 ], 135 "body": "body", 136 "body_type": "data", 137 "created_by": { 138 "type": "dev_user" 139 }, 140 "created_date": "created_date", 141 "display_id": "display_id", 142 "modified_by": { 143 "type": "dev_user" 144 }, 145 "modified_date": "modified_date", 146 "object_type": "capability", 147 "snap_kit_body": { 148 "body": {}, 149 "snap_in_action_name": "snap_in_action_name", 150 "snap_in_id": "snap_in_id" 151 }, 152 "snap_widget_body": [ 153 { 154 "type": "type" 155 }, 156 { 157 "type": "type" 158 } 159 ], 160 "visibility": "external" 161 } 162 ], 163 "metadata": { 164 "url_context": "url_context" 165 }, 166 "modified_by": { 167 "type": "dev_user", 168 "id": "id", 169 "display_id": "display_id", 170 "display_name": "display_name", 171 "display_picture": { 172 "id": "id", 173 "display_id": "display_id", 174 "file": {} 175 }, 176 "email": "email", 177 "full_name": "full_name", 178 "state": "active" 179 }, 180 "modified_date": "modified_date", 181 "owned_by": [ 182 { 183 "type": "dev_user", 184 "id": "id", 185 "display_id": "display_id", 186 "display_name": "display_name", 187 "display_picture": { 188 "id": "id", 189 "display_id": "display_id", 190 "file": {} 191 }, 192 "email": "email", 193 "full_name": "full_name", 194 "state": "active" 195 }, 196 { 197 "type": "dev_user", 198 "id": "id", 199 "display_id": "display_id", 200 "display_name": "display_name", 201 "display_picture": { 202 "id": "id", 203 "display_id": "display_id", 204 "file": {} 205 }, 206 "email": "email", 207 "full_name": "full_name", 208 "state": "active" 209 } 210 ], 211 "sla_summary": { 212 "closest_to_breach_metric": "closest_to_breach_metric", 213 "org_schedule": { 214 "id": "id", 215 "status": "archived", 216 "display_id": "display_id", 217 "name": "name", 218 "timezone": "timezone", 219 "valid_until": "valid_until" 220 }, 221 "remaining_time": 1, 222 "sla_tracker": { 223 "id": "id", 224 "metric_target_summaries": [ 225 { 226 "metric_definition": { 227 "id": "id", 228 "name": "name" 229 }, 230 "stage": "stage", 231 "breached_at": "breached_at", 232 "completed_at": "completed_at", 233 "completed_in": 1, 234 "in_policy": true, 235 "is_out_of_schedule": true, 236 "next_schedule_transition": "next_schedule_transition", 237 "org_schedule": { 238 "status": "archived" 239 }, 240 "remaining_time": 1, 241 "status": "status", 242 "target_time": "target_time", 243 "warning_target_time": "warning_target_time" 244 }, 245 { 246 "metric_definition": { 247 "id": "id", 248 "name": "name" 249 }, 250 "stage": "stage", 251 "breached_at": "breached_at", 252 "completed_at": "completed_at", 253 "completed_in": 1, 254 "in_policy": true, 255 "is_out_of_schedule": true, 256 "next_schedule_transition": "next_schedule_transition", 257 "org_schedule": { 258 "status": "archived" 259 }, 260 "remaining_time": 1, 261 "status": "status", 262 "target_time": "target_time", 263 "warning_target_time": "warning_target_time" 264 } 265 ], 266 "applies_to_id": "applies_to_id", 267 "applies_to_type": "conversation", 268 "created_by": { 269 "type": "dev_user" 270 }, 271 "created_date": "created_date", 272 "display_id": "display_id", 273 "modified_by": { 274 "type": "dev_user" 275 }, 276 "modified_date": "modified_date", 277 "removed_sla_metric_history": [ 278 {}, 279 {} 280 ], 281 "sla": { 282 "id": "id", 283 "name": "name", 284 "status": "archived", 285 "display_id": "display_id", 286 "sla_type": "external" 287 }, 288 "sla_policy_id": "sla_policy_id", 289 "stage": "stage", 290 "status": "status" 291 }, 292 "stage": "breached", 293 "target_time": "target_time" 294 }, 295 "sla_tracker": { 296 "id": "id", 297 "applies_to_type": "conversation", 298 "display_id": "display_id" 299 }, 300 "stage": { 301 "name": "name" 302 }, 303 "tags": [ 304 { 305 "tag": { 306 "id": "id", 307 "name": "name", 308 "display_id": "display_id" 309 }, 310 "value": "value" 311 }, 312 { 313 "tag": { 314 "id": "id", 315 "name": "name", 316 "display_id": "display_id" 317 }, 318 "value": "value" 319 } 320 ], 321 "title": "title" 322 } 323 }

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	"channels": [
43	{
44	"id": "id",
45	"display_id": "display_id"
46	},
47	{
48	"id": "id",
49	"display_id": "display_id"
50	}
51	],
52	"created_by": {
53	"type": "dev_user",
54	"id": "id",
55	"display_id": "display_id",
56	"display_name": "display_name",
57	"display_picture": {
58	"id": "id",
59	"display_id": "display_id",
60	"file": {}
61	},
62	"email": "email",
63	"full_name": "full_name",
64	"state": "active"
65	},
66	"created_date": "created_date",
67	"description": "description",
68	"display_id": "display_id",
69	"group": {
70	"id": "id",
71	"display_id": "display_id"
72	},
73	"messages": [
74	{
75	"type": "timeline_comment",
76	"id": "id",
77	"object": "object",
78	"object_display_id": "object_display_id",
79	"artifacts": [
80	{
81	"id": "id",
82	"display_id": "display_id",
83	"file": {}
84	},
85	{
86	"id": "id",
87	"display_id": "display_id",
88	"file": {}
89	}
90	],
91	"body": "body",
92	"body_type": "data",
93	"created_by": {
94	"type": "dev_user"
95	},
96	"created_date": "created_date",
97	"display_id": "display_id",
98	"modified_by": {
99	"type": "dev_user"
100	},
101	"modified_date": "modified_date",
102	"object_type": "capability",
103	"snap_kit_body": {
104	"body": {},
105	"snap_in_action_name": "snap_in_action_name",
106	"snap_in_id": "snap_in_id"
107	},
108	"snap_widget_body": [
109	{
110	"type": "type"
111	},
112	{
113	"type": "type"
114	}
115	],
116	"visibility": "external"
117	},
118	{
119	"type": "timeline_comment",
120	"id": "id",
121	"object": "object",
122	"object_display_id": "object_display_id",
123	"artifacts": [
124	{
125	"id": "id",
126	"display_id": "display_id",
127	"file": {}
128	},
129	{
130	"id": "id",
131	"display_id": "display_id",
132	"file": {}
133	}
134	],
135	"body": "body",
136	"body_type": "data",
137	"created_by": {
138	"type": "dev_user"
139	},
140	"created_date": "created_date",
141	"display_id": "display_id",
142	"modified_by": {
143	"type": "dev_user"
144	},
145	"modified_date": "modified_date",
146	"object_type": "capability",
147	"snap_kit_body": {
148	"body": {},
149	"snap_in_action_name": "snap_in_action_name",
150	"snap_in_id": "snap_in_id"
151	},
152	"snap_widget_body": [
153	{
154	"type": "type"
155	},
156	{
157	"type": "type"
158	}
159	],
160	"visibility": "external"
161	}
162	],
163	"metadata": {
164	"url_context": "url_context"
165	},
166	"modified_by": {
167	"type": "dev_user",
168	"id": "id",
169	"display_id": "display_id",
170	"display_name": "display_name",
171	"display_picture": {
172	"id": "id",
173	"display_id": "display_id",
174	"file": {}
175	},
176	"email": "email",
177	"full_name": "full_name",
178	"state": "active"
179	},
180	"modified_date": "modified_date",
181	"owned_by": [
182	{
183	"type": "dev_user",
184	"id": "id",
185	"display_id": "display_id",
186	"display_name": "display_name",
187	"display_picture": {
188	"id": "id",
189	"display_id": "display_id",
190	"file": {}
191	},
192	"email": "email",
193	"full_name": "full_name",
194	"state": "active"
195	},
196	{
197	"type": "dev_user",
198	"id": "id",
199	"display_id": "display_id",
200	"display_name": "display_name",
201	"display_picture": {
202	"id": "id",
203	"display_id": "display_id",
204	"file": {}
205	},
206	"email": "email",
207	"full_name": "full_name",
208	"state": "active"
209	}
210	],
211	"sla_summary": {
212	"closest_to_breach_metric": "closest_to_breach_metric",
213	"org_schedule": {
214	"id": "id",
215	"status": "archived",
216	"display_id": "display_id",
217	"name": "name",
218	"timezone": "timezone",
219	"valid_until": "valid_until"
220	},
221	"remaining_time": 1,
222	"sla_tracker": {
223	"id": "id",
224	"metric_target_summaries": [
225	{
226	"metric_definition": {
227	"id": "id",
228	"name": "name"
229	},
230	"stage": "stage",
231	"breached_at": "breached_at",
232	"completed_at": "completed_at",
233	"completed_in": 1,
234	"in_policy": true,
235	"is_out_of_schedule": true,
236	"next_schedule_transition": "next_schedule_transition",
237	"org_schedule": {
238	"status": "archived"
239	},
240	"remaining_time": 1,
241	"status": "status",
242	"target_time": "target_time",
243	"warning_target_time": "warning_target_time"
244	},
245	{
246	"metric_definition": {
247	"id": "id",
248	"name": "name"
249	},
250	"stage": "stage",
251	"breached_at": "breached_at",
252	"completed_at": "completed_at",
253	"completed_in": 1,
254	"in_policy": true,
255	"is_out_of_schedule": true,
256	"next_schedule_transition": "next_schedule_transition",
257	"org_schedule": {
258	"status": "archived"
259	},
260	"remaining_time": 1,
261	"status": "status",
262	"target_time": "target_time",
263	"warning_target_time": "warning_target_time"
264	}
265	],
266	"applies_to_id": "applies_to_id",
267	"applies_to_type": "conversation",
268	"created_by": {
269	"type": "dev_user"
270	},
271	"created_date": "created_date",
272	"display_id": "display_id",
273	"modified_by": {
274	"type": "dev_user"
275	},
276	"modified_date": "modified_date",
277	"removed_sla_metric_history": [
278	{},
279	{}
280	],
281	"sla": {
282	"id": "id",
283	"name": "name",
284	"status": "archived",
285	"display_id": "display_id",
286	"sla_type": "external"
287	},
288	"sla_policy_id": "sla_policy_id",
289	"stage": "stage",
290	"status": "status"
291	},
292	"stage": "breached",
293	"target_time": "target_time"
294	},
295	"sla_tracker": {
296	"id": "id",
297	"applies_to_type": "conversation",
298	"display_id": "display_id"
299	},
300	"stage": {
301	"name": "name"
302	},
303	"tags": [
304	{
305	"tag": {
306	"id": "id",
307	"name": "name",
308	"display_id": "display_id"
309	},
310	"value": "value"
311	},
312	{
313	"tag": {
314	"id": "id",
315	"name": "name",
316	"display_id": "display_id"
317	},
318	"value": "value"
319	}
320	],
321	"title": "title"
322	}
323	}