Skip to main content
POST
/
public
/
api
/
v1
/
inboxes
/
{inbox_identifier}
/
contacts
/
{contact_identifier}
/
conversations
/
{conversation_id}
/
toggle_typing
Toggle typing status
curl --request POST \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/toggle_typing \
  --header 'Content-Type: application/json' \
  --data '
{
  "typing_status": "on"
}
'
{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Path Parameters

​
inbox_identifier
string
required

The identifier obtained from API inbox channel

​
contact_identifier
string
required

The source id of contact obtained on contact create

​
conversation_id
integer
required

The numeric ID of the conversation

Query Parameters

​
typing_status
string
required

Typing status, either 'on' or 'off'

Body

application/json
​
typing_status
enum<string>

The typing status to set

Available options:
on,
off
Example:

"on"

Response

Typing status toggled successfully