Create Conversation (Beta) — DevRev

Creates a conversation.

Request

This endpoint expects an object.

typeenumRequired

Allowed values: support

brandstringOptionalformat: "id"

The brand associated with the conversation.

channelslist of stringsOptional

Channel IDs of the conversation.

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"

Description for the conversation.

groupstringOptionalformat: "id"

The group that the conversation is associated with.

is_spambooleanOptional

Whether the conversation is spam.

memberslist of stringsOptional

The users in the conversation.

messageslist of objectsOptional

Initial messages on the conversation.

metadataobjectOptional

owned_bylist of stringsOptional

The users that own the conversation.

source_channelstringOptionalformat: "text"

Whether the conversation is from a source channel.

source_channel_v2stringOptionalformat: "id"

Source channel ID of the conversation.

stageobjectOptional

Sets an object’s initial stage.

tagslist of objectsOptional

Tags associated with the conversation.

titlestringOptionalformat: "text"

The title for the conversation.

user_sessionslist of stringsOptional

The IDs of user sessions associated with the conversation.

Response

The response to creating a new conversation.

conversationobject

Errors

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

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

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

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