Inquirly
  1. Conversations
Inquirly
  • Accounts
    • Create an Account
      POST
    • Get an account details
      GET
    • Update an account
      PATCH
    • Delete an Account
      DELETE
  • Account Users
    • List all Account Users
      GET
    • Create an Account User
      POST
    • Delete an Account User
      DELETE
  • AgentBots
    • List all AgentBots
      GET
    • Create an Agent Bot
      POST
    • Get an agent bot details
      GET
    • Update an agent bot
      PATCH
    • Delete an AgentBot
      DELETE
  • Users
    • Create a User
      POST
    • Get an user details
      GET
    • Update a user
      PATCH
    • Delete a User
      DELETE
    • Get User SSO Link
      GET
  • Inbox API
    • Inbox details
  • Contacts API
    • Create a contact
    • Get a contact
    • Update a contact
  • Conversations API
    • Create a conversation
    • List all conversations
    • Get a single conversation
    • Resolve a conversation
    • Toggle typing status
    • Update last seen
  • Messages API
    • Create a message
    • List all messages
    • Update a message
  • Contact Labels
    • List Labels
    • Add Labels
  • CSAT Survey Page
    • Get CSAT survey page
  • Account AgentBots
    • List all AgentBots
    • Create an Agent Bot
    • Get an agent bot details
    • Update an agent bot
    • Delete an AgentBot
  • Agents
    • List Agents in Account
    • Add a New Agent
    • Update Agent in Account
    • Remove an Agent from Account
  • Canned Responses
    • List all Canned Responses in an Account
    • Add a New Canned Response
    • Remove a Canned Response from Account
  • Canned Response
    • Update Canned Response in Account
  • Custom Attributes
    • List all custom attributes in an account
    • Add a new custom attribute
    • Get a custom attribute details
    • Update custom attribute in Account
    • Remove a custom attribute from account
  • Contacts
    • List Contacts
    • Create Contact
    • Show Contact
    • Update Contact
    • Delete Contact
    • Contact Conversations
    • Search Contacts
    • Contact Filter
  • Contact
    • Create contact inbox
    • Get Contactable Inboxes
  • Automation Rule
    • List all automation rules in an account
    • Add a new automation rule
    • Get a automation rule details
    • Update automation rule in Account
    • Remove a automation rule from account
  • Help Center
    • Add a new portal
    • List all portals in an account
    • update a new portal
    • Add a new category
    • Add a new article
  • Conversations
    • Get Conversation Counts
      GET
    • Conversations List
      GET
    • Create New Conversation
      POST
    • Conversations Filter
      POST
    • Conversation Details
      GET
    • Update Conversation
      PATCH
    • Toggle Status
      POST
    • Toggle Priority
      POST
  • Conversation Assignment
    • Assign Conversation
  • Conversation Labels
    • List Labels
    • Add Labels
  • Inboxes
    • List all inboxes
    • Get an inbox
    • Create an inbox
    • Update Inbox
    • Show Inbox Agent Bot
    • Add or remove agent bot
    • List Agents in Inbox
    • Add a New Agent
    • Update Agents in Inbox
    • Remove an Agent from Inbox
  • Messages
    • Get messages
    • Create New Message
    • Delete a message
  • Integrations
    • List all the Integrations
    • Create an integration hook
    • Update an Integration Hook
    • Delete an Integration Hook
  • Profile
    • Fetch user profile
  • Teams
    • List all teams
    • Create a team
    • Get a team details
    • Update a team
    • Delete a team
    • List Agents in Team
    • Add a New Agent
    • Update Agents in Team
    • Remove an Agent from Team
  • Custom Filters
    • List all custom filters
    • Create a custom filter
    • Get a custom filter details
    • Update a custom filter
    • Delete a custom filter
  • Webhooks
    • List all webhooks
    • Add a webhook
    • Update a webhook object
    • Delete a webhook
  • Reports
    • Get Account reports
    • Get Account reports summary
    • Account Conversation Metrics
    • Agent Conversation Metrics
  1. Conversations

Create New Conversation

POST
/api/v1/accounts/{account_id}/conversations
Conversations
Creating a conversation in chatwoot requires a source id.
Learn more about source_id: https://github.com/chatwoot/chatwoot/wiki/Building-on-Top-of-Chatwoot:-Importing-Existing-Contacts-and-Creating-Conversations
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/accounts//conversations' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "source_id": "string",
    "inbox_id": "string",
    "contact_id": "string",
    "additional_attributes": {},
    "custom_attributes": {
        "attribute_key": "attribute_value",
        "priority_conversation_number": 3
    },
    "status": "open",
    "assignee_id": "string",
    "team_id": "string",
    "message": {
        "content": "string",
        "template_params": {
            "name": "sample_issue_resolution",
            "category": "UTILITY",
            "language": "en_US",
            "processed_params": {
                "1": "Chatwoot"
            }
        }
    }
}'
Response Response Example
200 - Example 1
{
    "id": 0,
    "account_id": 0,
    "inbox_id": 0
}

Request

Path Params
account_id
string 
required
Body Params application/json; charset=utf-8
source_id
string 
required
Conversation source id
inbox_id
string 
required
Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email
contact_id
string 
optional
Contact Id for which conversation is created
additional_attributes
object 
optional
Lets you specify attributes like browser information
custom_attributes
object 
optional
The object to save custom attributes for conversation, accepts custom attributes key and value
Example:
{"attribute_key":"attribute_value","priority_conversation_number":3}
status
enum<string> 
optional
Specify the conversation whether it's pending, open, closed
Allowed values:
openresolvedpending
assignee_id
string 
optional
Agent Id for assigning a conversation to an agent
team_id
string 
optional
Team Id for assigning a conversation to a team
message
object 
optional
The initial message to be sent to the conversation
content
string 
required
The content of the message
template_params
object 
optional
The template params for the message in case of whatsapp Channel
Examples

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
id
number 
optional
ID of the conversation
account_id
number 
optional
Account Id
inbox_id
number 
optional
ID of the inbox
🟠403Forbidden
Previous
Conversations List
Next
Conversations Filter
Built with