Skip to contentSkip to navigationSkip to topbar

Update Conversation Summary


(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum(link takes you to an external page). For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data(link takes you to an external page). As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Conversations products are only available in the new Twilio Console(link takes you to an external page). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

PATCH/v1/Stores/{storeId}/Profiles/{profileId}/ConversationSummaries/{summaryId}

Base url: https://memory.twilio.com (base url)

Partially update a specific conversation summary by its ID. Only provided fields will be updated. The updated timestamp will be automatically set. This allows for selective updates without needing to provide all fields.


Request

patch-profile-conversation-summary-request page anchor

Authentication

authentication page anchor
Property nameTypeRequiredPIIDescription
storeIdstring
required
Not PII

A unique Memory Store ID using Twilio Type ID (TTID) format

Example: mem_store_00000000000000000000000000Pattern: ^mem_(store|service)_[0-7][0-9a-z]{25}$

profileIdstring
required

The unique identifier for the profile using Twilio Type ID (TTID) format.

Example: mem_profile_00000000000000000000000000Pattern: ^mem_profile_[0-7][0-9a-z]{25}$

summaryIdstring
required

The summary ID.

Example: mem_summary_00000000000000000000000000Pattern: ^mem_summary_[0-7][0-9a-z]{25}$
Encoding type:application/json
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
sourcestring

Optional

The source system that generated the summary. Allows letters, numbers, spaces, and URL-safe symbols. Excludes URL-unsafe characters like quotes, angle brackets, and control characters.

Example: conversationsPattern: ^[a-zA-Z0-9 _.-]+$Max length: 100

contentstring

Optional

The main content of the summary.

Example: Customer discussed billing concerns and was satisfied with the resolution provided during this conversation.Min length: 1Max length: 4096

occurredAtstring<date-time>

Optional

The timestamp when the summary was originally created. If not provided, defaults to the time the summary was received.

Example: 2025-01-15T10:15:30Z

conversationIdstring

Optional

A unique identifier for the conversation using Twilio Type ID (TTID) format.

Example: conv_conversation_00000000000000000000000000Pattern: ^conv_conversation_[0-7][0-9a-z]{25}$

202308400401403404429500503

Conversation summary update accepted and is being processed.

Schema
Property nameTypeRequiredPIIDescriptionChild properties
messagestring

Optional

Example: Conversation summary update acceptedMax length: 255
Update Conversation SummaryLink to code sample: Update Conversation Summary
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function patchProfileConversationSummary() {
11
const conversationSummary = await client.memory.v1
12
.conversationSummaries(
13
"mem_store_00000000000000000000000000",
14
"mem_profile_00000000000000000000000000",
15
"mem_summary_00000000000000000000000000"
16
)
17
.patch({
18
content:
19
"Updated: Customer discussed billing concerns and expressed complete satisfaction with the comprehensive resolution provided during this conversation.",
20
});
21
22
console.log(conversationSummary.message);
23
}
24
25
patchProfileConversationSummary();

Response

Note about this response
1
{
2
"message": "message"
3
}