ChatWoot Client icon

ChatWoot Client

Interact with ChatWoot Client APIs

Conversations API → Toggle Typing Status

AI-generated

Summary

Toggle the typing status ('on' or 'off') for a specific conversation linked to a contact within an inbox in ChatWoot.

Inputs

  • Contact Identifier Name or ID (required) — Select or specify the identifier or name of the contact whose conversation's typing status you want to toggle.
  • Conversation Name or ID (required) — Select or specify the conversation identifier or name where the typing status will be toggled.
  • Typing Status (required) — Set the typing status value to 'on' or 'off' to indicate whether typing is active or not in the conversation.

Output shape

a JSON object representing the response from the ChatWoot API after toggling the typing status of the conversation.

The response shape depends on ChatWoot's API; typically it confirms the updated typing status or returns relevant metadata about the conversation. No automatic pagination applies.

Examples

Example 1: Toggle typing status to 'on' for a specific conversation and contact

Provide the contact identifier, conversation ID, and set Typing Status to 'on' to notify ChatWoot that typing has started.

Links

Discussion