Update Configuration

(information)

Legal information

Conversation Orchestrator, 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. For details on AI usage and data, see the AI Nutrition Facts for Real-Time Transcription and Conversation Relay.

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

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

PUT/v2/ControlPlane/Configurations/{id}

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

Update an existing Configuration

Request

Authentication

Basic Auth

Headers

Property nameTypeRequiredPIIDescription

idempotency-Keystring

Optional

Not PII

Client-generated UUID key to ensure idempotent behavior. Submitting the same key returns the original response without creating a duplicate operation. Keys are scoped to account + region with a 24-hour TTL.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Path parameters

Property nameTypeRequiredPIIDescription

idstring

required

Not PII

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredPIIDescriptionChild properties

displayNamestring

Optional

Not PII

A human-readable name for the configuration. Limited to 32 characters.

Example: My Support ConfigPattern: ^[a-zA-Z0-9-_ ]+$Max length: 32

descriptionstring

required

Not PII

Human-readable description for the configuration.

Example: Updated Customer Support ConfigurationMax length: 512

conversationGroupingTypeenum<string>

required

Not PII

Type of Conversation grouping strategy:

GROUP_BY_PROFILE: Groups Communications by resolved Profile from the Memory Store. A Profile is looked up or created for CUSTOMER Participant types. All Communications from the same Profile are in the same Conversation, regardless of address or channel.
GROUP_BY_PARTICIPANT_ADDRESSES: Groups Communications by Participant addresses across all channels. A customer using +18005550100 will be in the same Conversation whether they contact by SMS, WhatsApp, or RCS.
GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE: Groups Communications by both Participant addresses AND channel. A customer using +18005550100 by SMS will be in a different Conversation than the same customer by Voice.

Example: GROUP_BY_PROFILEPossible values:

GROUP_BY_PROFILEGROUP_BY_PARTICIPANT_ADDRESSESGROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE

memoryStoreIdstring

required

Not PII

The Memory Store ID for profile resolution.

Example: memora_service_123

channelSettingsobject

required

Not PII

Show channelSettings properties

statusCallbacksarray[object]

Optional

Not PII

Max items: 2

Show statusCallbacks properties

intelligenceConfigurationIdsarray[string]

Optional

Not PII

A list of Conversational Intelligence configuration IDs.

Example: ["agent1","agent2"]Max items: 5

memoryExtractionEnabledboolean

Optional

Not PII

Whether memory extraction is enabled for conversations under this configuration. Defaults to false.

Default: falseExample: false

conversationsV1Bridgeobject

Optional

Not PII

Configuration for Conversations V1 bridge. When set, messaging channels route through Conversations V1. Use this to integrate with existing Conversations V1 applications.

Example: {"serviceId":"IS00000000000000000000000000000000"}

Show conversationsV1Bridge properties

Responses

202400404409429500503

Accepted - Operation created for asynchronous processing

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

statusUrlstring<uri>

Optional

Not PII

URL to poll for operation status.

Example: https://conversations.twilio.com/v2/ControlPlane/Operations/proc_job_01h9d8r0vte3hz8tykdj329t7r

relatedobject

Optional

Not PII

Named resource identifiers associated with this operation. Keys depend on the operation type:

config-create, config-update, config-delete: configurationId
conversation-delete: conversationId

Example: {"configurationId":"cfg_configuration_01h9d8r0vte3hz8tykdj329t7r"}

Show related properties

Update Configuration

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateConfiguration() {
11  const configuration = await client.conversations.v2
12    .configurations("id")
13    .update({
14      description: "description",
15      conversationGroupingType: "GROUP_BY_PROFILE",
16      memoryStoreId: "memoryStoreId",
17      channelSettings: {
18        additionalPropKey: {
19          statusTimeouts: {
20            inactive: 10,
21            closed: 15,
22          },
23          captureRules: [
24            {
25              from: "from",
26              to: "to",
27              metadata: {},
28            },
29          ],
30        },
31      },
32    });
33
34  console.log(configuration.statusUrl);
35}
36
37updateConfiguration();

Response

1{
2  "statusUrl": "https://conversations.twilio.com/v2/ControlPlane/Operations/proc_job_01h9d8r0vte3hz8tykdj329t7r",
3  "related": {
4    "configurationId": "cfg_configuration_01h9d8r0vte3hz8tykdj329t7r"
5  }
6}