Conversations

Update conversation details

Update the summary, common questions, and common topics of a specific conversation within a replica.

patch/v1/replicas/{replicaUUID}/conversations/{conversationUUID}

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/replicas/{replicaUUID}/conversations/{conversationUUID}
  • Auth: one of:
    • API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE
    • API key in header X-ORGANIZATION-SECRET

Path parameters

replicaUUIDstring uuid required

The replica unique identifier (UUID)

Example:03db5651-cb61-4bdf-9ef0-89561f7c9c53
conversationUUIDstring uuid required

The conversation UUID.

Example:4e162bcb-2a32-4b35-89bf-7cf729a73687

Headers

X-API-Versionstring
Example:2025-03-25
Content-Encoding'gzip'

Content encoding for request body compression. Optional - when used, client is responsible for gzipping and sending binary data.

Request body

summarystring nullable

The summary of the conversation.

commonQuestionsstring[]

Common questions asked in this conversation.

commonTopicsstring[]

Common topics discussed in this conversation.

Example request

{
  "summary": "A productive discussion about project planning and next steps.",
  "commonQuestions": [
    "What is blockchain?",
    "How does DeFi work?",
    "What are smart contracts?"
  ],
  "commonTopics": [
    "blockchain",
    "cryptocurrency",
    "smart contracts",
    "fintech"
  ]
}

Response

Conversation updated successfully

successboolean required

Indicates the status of the request

Changes

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