Update conversation details | Sensay API documentation

Update conversation details Deprecated

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

Organization service token & User Organization service token

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

Headers

X-API-Version string

Default value is 2025-03-25.

Path parameters

replicaUUID string(uuid) Required

The replica unique identifier (UUID)
conversationUUID string(uuid) Required

The conversation UUID.

application/json

Body

summary string | null

The summary of the conversation.

Maximum length is 700.
commonQuestions array[string]

Common questions asked in this conversation.
commonTopics array[string]

Common topics discussed in this conversation.

Responses

200 application/json

Conversation updated successfully
Hide response attribute Show response attribute object
- success boolean Required
  
  Indicates the status of the request
400 application/json

Bad Request
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
404 application/json

Not Found
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
415 application/json

Unsupported Media Type
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- error_code string
  
  A machine-readable error code indicating the specific error condition. Used for programmatic error handling
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- success boolean Required
  
  Indicates the status of the request
- error string Required
  
  A text representation of the error
- fingerprint string
  
  A unique identifier of the event, useful for reporting
- request_id string Required
  
  A unique identifier of the request, useful for reporting
- inner_exception object
  
  The inner exception
  
  Hide inner_exception attributes Show inner_exception attributes object
  
  name string Required
  
  message string Required
  
  cause string
  
  stack string

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

curl \
 --request PATCH 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/conversations/4e162bcb-2a32-4b35-89bf-7cf729a73687' \
 --header "X-ORGANIZATION-SECRET: $API_KEY" \
 --header "X-USER-ID: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-API-Version: 2025-03-25" \
 --data '{"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"]}'

Request examples

# Headers
X-API-Version: 2025-03-25

# Payload
{
  "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 examples (200)

{
  "success": true
}

Response examples (400)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (401)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (404)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (415)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}

Response examples (500)

{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "inner_exception": {
    "name": "Server overheated",
    "cause": "Request too complicated",
    "stack": "Error: Server overheated due to an unexpected situation\n    at Object.eval (eval at <anonymous>...",
    "message": "The server overheated due to an unexpected situation"
  }
}