freshworks · Schema

ConversationCreate

Properties

Name Type Description
app_id string ID of the Freshchat application.
channel_id string ID of the channel.
users array Users to involve in the conversation.
messages array Initial messages for the conversation.
View JSON Schema on GitHub

JSON Schema

freshworks-conversationcreate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConversationCreate",
  "title": "ConversationCreate",
  "type": "object",
  "required": [
    "app_id",
    "channel_id",
    "messages"
  ],
  "properties": {
    "app_id": {
      "type": "string",
      "description": "ID of the Freshchat application."
    },
    "channel_id": {
      "type": "string",
      "description": "ID of the channel."
    },
    "users": {
      "type": "array",
      "description": "Users to involve in the conversation.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "User ID."
          }
        }
      }
    },
    "messages": {
      "type": "array",
      "description": "Initial messages for the conversation.",
      "items": {
        "$ref": "#/components/schemas/MessageCreate"
      }
    }
  }
}