Chats

Update chat state

Update the state of a specific chat by its ID.

patch/chats/{chat_id}/state

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/chats/{chat_id}/state
  • Auth: HTTP bearer

Path parameters

chat_idstring required

Chat ID

Request body

state'OPEN' | 'CLOSED'

The state status of the chat

ai_enabledboolean

Whether AI is enabled for the chat

follow_up_atstring date-time nullable

Scheduled follow-up datetime (set null to cancel)

muted_untilstring date-time nullable

Mute the chat until this datetime (set null to clear). Max 1 year in the future.

csat_scoreinteger nullable

Customer satisfaction score (1-5)

Response

idstring required
titlestring nullable required

The title of the chat

modelstring required

The model used for the chat

org_idstring
temporaryboolean required

Whether the chat is temporary and would be deleted after 24 hours of last activity

visibility'PRIVATE' | 'PUBLIC_READ' | 'PUBLIC_WRITE' required

The visibility of the chat

pinnedboolean required

Whether the chat is pinned in the user interface

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' required

The status of the chat

linkstring

The link to the chat in the integration

shared_urlstring nullable required

The shared URL of the chat, if it is shared

spendnumber

What the organization paid for this chat's AI turns, in USD; org chats only

created_atstring date-time nullable required
updated_atstring date-time nullable required

Example response

{
  "last_message": {
    "messages": [
      {
        "parts": [
          {
            "audio": {
              "file_filename": "document.pdf",
              "file_size": 1024,
              "file_mimetype": "application/pdf"
            }
          }
        ]
      }
    ]
  },
  "referral": {
    "parts": [
      {
        "file": {
          "file_filename": "document.pdf",
          "file_size": 1024,
          "file_mimetype": "application/pdf"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.