LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
2.0.0
2.0.0
  • Getting Started
  • Widget
    • Overview
    • Installation
    • Customization
      • Settings
        • Greeting
        • Greeting Introduction
        • Conversation button
        • Conversation list title
        • Launcher Text
        • Widget Appearance
      • Methods
        • Widget visibility
        • Widget window state
        • Set Customer Info
        • Get Customer info
      • Events/Callbacks
        • reloadUI
        • onChatMaximize
        • onChatMinimize
        • onChatInitiated/Started
        • onChatClosed
        • onAgentAssign
        • onAgentStateChange (Available/Unavailable)
      • Link resources
        • Share channel link
  • SDK
    • [Under Development] Overview
    • [Under Development] iOS
      • [Under Development] iOS Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Initialization
      • [Under Development] Theme Setting
      • [Under Development] Acquire Delegates for iOS
      • [Under Development] Widget customization
      • [Under Development] React Native
    • [Under Development] Android
      • [Under Development] Android Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Acquire SDK APIs
      • [Under Development] Acquire Delegates for Android
      • [Under Development] React Native
  • Webhooks
    • Introduction
    • Getting Started
    • Securing Webhook
    • Webhook Events
  • REST APIs
    • Introduction
      • Request Types, Permissions, Errors, & Limits
    • Authorization
    • Conversation
      • Cases
        • Messages
          • Retrieve a list of messages
          • Retrieve a message
          • Send a message
          • Update message
          • Delete Message
        • Case List
        • Single Case
        • Create
        • Close Case
        • Reopen Case
        • Invite Agent
      • Snooze
        • [Under Construction] Delete Snooze
        • Create Snooze
      • Notes
        • List all notes
        • Retrieve a note
        • Create
        • Add note message
        • Delete note
        • Retrieve note messages
    • Contact
      • List all contacts
      • Retrieve a contact
      • Add contact
      • Block Contact
      • Merge contact
      • Update contact
      • Delete contact
    • Company
      • List all companies
      • Retrieve a company
      • Add company
      • Update company
      • Delete company
    • Phone
      • Call in queue
      • Ringing
      • Answered
      • Call end
    • Chatbot
      • Conversational Bot
        • Groups
          • Get Default Group
          • List
          • Add
          • Delete
          • Copy
        • Question And Answer
          • List
          • Get
          • Add
          • Update
          • Delete
          • Publish
          • Bulk Action
          • Push QnA To Suggestions
          • Import QnA
      • Sequence Bot
        • Sequence List
        • Get Single Sequence
        • Add
        • Update
        • Delete
        • Bulk Action
        • Copy Existing Sequence
        • Branch
          • Get Single Branch
          • Add
          • Update
          • Delete
          • Set as Parent Branch
      • Bot resources
      • Webhooks in chatbot
    • Analytics
      • Custom Reporting
      • General Analytics
      • Chat
        • Overview
        • Tags
        • Visitor Information
          • Visitor Analytics
          • Visitor Source Overview
        • Video Analytics
      • Cobrowse
      • Chatbot
        • Sequence Bot
        • Conversational Bot
      • Knowledge Base
      • Email
      • VoIP - Call SMS
      • Agent Performance
    • [Under Construction] Custom Cards
      • Timeline-cards
        • Create Interaction Card
        • Update Interaction Card
        • List all Cards
        • Retrieve a card
        • Delete card
      • Exclusive cards
        • Create general card
        • Create app card - from other system
        • Delete card
    • Knowledge Base
      • Groups
        • Add
        • Update
        • Get
        • Get Single
        • Delete
      • Articles
        • Add Article
        • Update Article
        • Delete Article
        • Get Articles
        • Get Single Article
      • Category
        • Add Category
        • Update Category
        • Delete Category
        • Get Category
    • Settings
      • Account Settings
        • Users
          • List
          • Get Single
          • Add
          • Update
          • Delete
        • Roles
          • List
          • Get Single Role
          • Add
          • Update
          • Delete
        • Departments
          • List
          • Get
          • Add
          • Update
          • Delete
        • Custom Attributes
          • List of custom attributes
          • Get a custom Attribute
          • Add a custom attribute
          • Update a custom attribute
          • Delete a custom attribute
      • Conversation Settings
        • Shortcuts
          • List Groups
          • Get
          • Add
          • Update
          • Delete
        • Tags
          • List All Tags
          • Get Single Tag
          • Add New Tag
          • Update Tag
          • Delete Tag
        • Feedback
          • List of all feedback
          • Get single feedback
          • Add feedback
          • Update Feedback
          • Delete feedback
      • Security
        • Block Visitor
          • List
          • Get
          • Add
          • Delete
        • Audit Logs
          • Audit Log
          • Audit Log Users
Powered by GitBook
On this page
  • Add QnA
  • Body(raw)
  1. REST APIs
  2. Chatbot
  3. Conversational Bot
  4. Question And Answer

Add

Add a new QnA

Add QnA

POST https://{{account_id}}.acquire.io/api/v1/bot/qna

Create a new QnA. The body must contain the following parameters: qnaGroupId - The ID of the group the QnA will be added to. qnaMainQuestions - An array of objects. Each question object must have a key of "question" with a value of the question you intend to add. Questions may be separated by a comma. qnaMainAnswers - An array of objects. Each answer object must have a key of "answer" with a value of the answer you intend to add. Answers may be separated by a comma. qnaMainActions - An array with a single object. Must have the keys "actionType" and "actionVal".

Headers

Name
Type
Description

Authorization

string

Bearer {{api_key}}

Request Body

Name
Type
Description

qnaMainActions

array

Array of objects.

qnaMainAnswers

array

Array of objects. Each answer should be written as a string.

qnaMainQuestions

array

Array of objects. Each question should be written as a string.

qnaGroupId

integer

Group ID that the QnA will be added to

{
  "data": {
    "success": true,
    "message": "Question Added Successfully",
    "addedObject": {
      "id": 3781,
      "type": "suggested",
      "subtype": "user_added",
      "status": "active",
      "language": "en",
      "answerType": "random",
      "actionEnabled": "active",
      "wantFeedback": "active",
      "askedCount": 0,
      "allowRelatedQue": "active",
      "relatedQueIds": "1",
      "createdBy": 1,
      "updatedBy": 1,
      "dateCreated": "2021-03-18T07:13:02.390Z",
      "dateUpdated": "2021-03-18T07:13:02.390Z",
      "qnaMainQuestions": [
        {
          "question": "Test Question 1",
          "id": 5773
        },
        {
          "question": "Test Question 2",
          "qnaMain": {
            "type": "suggested",
            "subtype": "user_added",
            "status": "active",
            "language": "en",
            "answerType": "random",
            "actionEnabled": "active",
            "wantFeedback": "active",
            "askedCount": 0,
            "allowRelatedQue": "active",
            "relatedQueIds": "1",
            "createdBy": 1,
            "updatedBy": 1,
            "dateCreated": "2021-03-18T07:13:02.390Z",
            "dateUpdated": "2021-03-18T07:13:02.390Z",
            "qnaMainQuestions": [
              {
                "question": "Test Question 1",
                "id": 5773
              },
              {
                "question": "Test Question 2",
                "id": 5774
              }
            ],
            "qnaMainAnswers": [
              {
                "answer": "Test Answer 1",
                "answerJson": null,
                "id": 4595
              },
              {
                "answer": "Test Answer 2",
                "answerJson": null,
                "id": 4596
              }
            ],
            "qnaMainActions": [
              {
                "parent": null,
                "triggerType": "auto",
                "buttonVal": "",
                "actionType": "follow_up",
                "actionVal": "Test1",
                "id": 182
              }
            ],
            "id": 3781
          },
          "id": 5774
        }
      ],
      "qnaMainAnswers": [
        {
          "answer": "Test Answer 1",
          "answerJson": null,
          "id": 4595
        },
        {
          "answer": "Test Answer 2",
          "answerJson": null,
          "qnaMain": {
            "type": "suggested",
            "subtype": "user_added",
            "status": "active",
            "language": "en",
            "answerType": "random",
            "actionEnabled": "active",
            "wantFeedback": "active",
            "askedCount": 0,
            "allowRelatedQue": "active",
            "relatedQueIds": "1",
            "createdBy": 1,
            "updatedBy": 1,
            "dateCreated": "2021-03-18T07:13:02.390Z",
            "dateUpdated": "2021-03-18T07:13:02.390Z",
            "qnaMainQuestions": [
              {
                "question": "Test Question 1",
                "id": 5773
              },
              {
                "question": "Test Question 2",
                "id": 5774
              }
            ],
            "qnaMainAnswers": [
              {
                "answer": "Test Answer 1",
                "answerJson": null,
                "id": 4595
              },
              {
                "answer": "Test Answer 2",
                "answerJson": null,
                "id": 4596
              }
            ],
            "qnaMainActions": [
              {
                "parent": null,
                "triggerType": "auto",
                "buttonVal": "",
                "actionType": "follow_up",
                "actionVal": "Test1",
                "id": 182
              }
            ],
            "id": 3781
          },
          "id": 4596
        }
      ],
      "tenantId": "r4b4fl"
    }
  }
}

Body(raw)

{
  "qnaGroupId": 1,
  "type": "suggested",
  "answerType": "random",
  "status": "active",
  "language": "en",
  "actionEnabled": "active",
  "wantFeedback": "active",
  "allowRelatedQue": "active",
  "relatedQueIds": "1",
  "qnaMainQuestions": [
    {
      "question": "Test Question 1"
    },
    {
      "question": "Test Question 2"
    }
  ],
  "qnaMainAnswers": [
    {
      "answer": "Test Answer 1"
    },
    {
      "answer": "Test Answer 2"
    }
  ],
  "qnaMainActions": [
    {
      "actionType": "follow_up",
      "actionVal": "Test1",
      "qnaMainActions": [],
      "triggerType": "auto"
    }
  ]
}
PreviousGetNextUpdate

Last updated 4 years ago