Conversations
Create Conversation
Creates a conversation.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
typeconversations-create-request-type-value
Value in
"support"brand?string
The brand associated with the conversation.
Format
idchannels?array<string>
Channel IDs of the conversation.
custom_fields?object
Application-defined custom fields.
Empty Object
custom_schema_spec?custom-schema-spec
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.
description?string
Description for the conversation.
Format
textgroup?string
The group that the conversation is associated with.
Format
idis_spam?boolean
Whether the conversation is spam.
members?array<string>
The users in the conversation.
messages?array<conversations-create-request-message>
Initial messages on the conversation.
metadata?conversations-create-request-metadata
owned_by?array<string>
The users that own the conversation.
source_channel?string
Whether the conversation is from a source channel.
Format
textsource_channel_v2?string
Source channel ID of the conversation.
Format
idstage?stage-init
Sets an object's initial stage.
tags?array<set-tag-with-value>
Tags associated with the conversation.
title?string
The title for the conversation.
Format
textResponse Body
curl -X POST "https://api.devrev.ai/conversations.create" \ -H "Content-Type: application/json" \ -d '{ "type": "support" }'{
"conversation": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"channels": [
{
"display_id": "string",
"id": "string"
}
],
"description": "string",
"group": {
"display_id": "string",
"id": "string"
},
"members": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"messages": [
{
"type": "timeline_comment",
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"object": "string",
"object_display_id": "string",
"object_type": "article",
"visibility": "external",
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"body": "string",
"body_type": "data",
"references": [
{
"type": "article",
"display_id": "string",
"id": "string",
"article_type": "article",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"title": "string"
}
],
"snap_kit_body": {
"body": {},
"snap_in_action_name": "string",
"snap_in_id": "string"
},
"snap_widget_body": [
{
"type": "string"
}
]
}
],
"metadata": {
"url_context": "string"
},
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"sla_summary": {
"closest_to_breach_metric": "string",
"org_schedule": {
"display_id": "string",
"id": "string",
"name": "string",
"status": "archived",
"timezone": "string",
"valid_until": "2023-01-01T12:00:00.000Z"
},
"remaining_time": 0,
"sla_tracker": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"applies_to_id": "string",
"applies_to_type": "conversation",
"metric_target_summaries": [
{
"breached_at": "2023-01-01T12:00:00.000Z",
"completed_at": "2023-01-01T12:00:00.000Z",
"completed_in": 0,
"in_policy": true,
"is_out_of_schedule": true,
"metric_definition": {
"display_id": "string",
"id": "string",
"name": "string"
},
"next_schedule_transition": "2023-01-01T12:00:00.000Z",
"org_schedule": {
"display_id": "string",
"id": "string",
"name": "string",
"status": "archived",
"timezone": "string",
"valid_until": "2023-01-01T12:00:00.000Z"
},
"remaining_time": 0,
"stage": "string",
"status": "string",
"target_time": "2023-01-01T12:00:00.000Z",
"warning_target_time": "2023-01-01T12:00:00.000Z"
}
],
"removed_sla_metric_history": [
{}
],
"sla": {
"display_id": "string",
"id": "string",
"name": "string",
"sla_type": "external",
"status": "archived"
},
"sla_policy_id": "string",
"stage": "string",
"status": "string"
},
"stage": "breached",
"target_time": "2023-01-01T12:00:00.000Z"
},
"sla_tracker": {
"display_id": "string",
"id": "string",
"applies_to_type": "conversation"
},
"source_channel": "string",
"source_channel_v2": {
"display_id": "string",
"id": "string"
},
"stage": {
"name": "string"
},
"tags": [
{
"tag": {
"display_id": "string",
"id": "string",
"name": "string"
},
"value": "string"
}
],
"title": "string"
}
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}