Inquirly
  1. Messages
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
      GET
  • Contacts API
    • Create a contact
      POST
    • Get a contact
      GET
    • Update a contact
      PATCH
  • 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
    • Conversations List
    • Create New Conversation
    • Conversations Filter
    • Conversation Details
    • Update Conversation
    • Toggle Status
    • Toggle Priority
  • 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
      GET
    • Create New Message
      POST
    • Delete a message
      DELETE
  • 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. Messages

Create New Message

POST
/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
Messages
Create a new message in the conversation
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/accounts//conversations//messages' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "content": "string",
    "message_type": "outgoing",
    "private": true,
    "content_type": "text",
    "content_attributes": {},
    "template_params": {
        "name": "sample_issue_resolution",
        "category": "UTILITY",
        "language": "en_US",
        "processed_params": {
            "1": "Chatwoot"
        }
    }
}'
Response Response Example
200 - Example 1
{
    "id": 0,
    "content": "string",
    "content_type": "text",
    "content_attributes": {},
    "message_type": "incoming",
    "created_at": 0,
    "private": true,
    "attachment": {},
    "sender": {},
    "conversation_id": 0
}

Request

Path Params
account_id
string 
required
conversation_id
string 
required
Body Params application/json; charset=utf-8
content
string 
required
The content of the message
message_type
enum<string> 
optional
Allowed values:
outgoingincoming
private
boolean 
optional
Flag to identify if it is a private note
content_type
enum<string> 
optional
if you want to create custom message types
Allowed values:
textinput_emailcardsinput_selectformarticle
Example:
cards
content_attributes
object 
optional
attributes based on your content type
template_params
object 
optional
The template params for the message in case of whatsapp Channel
name
string 
optional
Name of the template
Example:
sample_issue_resolution
category
string 
optional
Category of the template
Example:
UTILITY
language
string 
optional
Language of the template
Example:
en_US
processed_params
object 
optional
The processed param values for template variables in template
Example:
{"1":"Chatwoot"}
Examples

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
id
number 
optional
content
string 
optional
The text content of the message
content_type
enum<string> 
optional
The type of the template message
Allowed values:
textinput_selectcardsform
content_attributes
object 
optional
The content attributes for each content_type
message_type
enum<string> 
optional
The type of the message
Allowed values:
incomingoutgoingactivitytemplate
created_at
integer 
optional
The time at which message was created
private
boolean 
optional
The flags which shows whether the message is private or not
attachment
object 
optional
The file object attached to the image
sender
object 
optional
User/Agent/AgentBot object
conversation_id
number 
optional
ID of the conversation
🟠403Forbidden
🟠404Record Not Found
Previous
Get messages
Next
Delete a message
Built with