TWtwilio
ConversationsV2Configuration

Patch Configuration

Changed on

Partially update a Configuration. Only fields present in the request body are changed; omitted fields are left untouched. For channelSettings, an omitted channel key is preserved, a channel key mapped to a value replaces that channel's settings, and a channel key explicitly mapped to null removes it.

patch/v2/ControlPlane/Configurations/{id}

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v2/ControlPlane/Configurations/{id}
  • Auth
    HTTP basic

Headers

Idempotency-Keystring

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.

Request body

displayNamestring nullable

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

descriptionstring nullable

Human-readable description for the configuration.

conversationGroupingType'GROUP_BY_PROFILE' | 'GROUP_BY_PARTICIPANT_ADDRESSES' | 'GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE'

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.
memoryStoreIdstring nullable

The Memory Store ID for profile resolution.

channelSettingsobject

Channel-specific settings to merge onto the existing channelSettings map. A channel key mapped to a value replaces that channel's settings; a channel key explicitly mapped to null removes it; an omitted channel key is left untouched.

intelligenceConfigurationIdsstring[] nullable

A list of Conversational Intelligence configuration IDs.

memoryExtractionEnabledboolean nullable

Whether memory extraction is enabled for conversations under this configuration.

Example request

{
  "displayName": "My Support Config",
  "description": "Updated Customer Support Configuration",
  "conversationGroupingType": "GROUP_BY_PROFILE",
  "memoryStoreId": "memora_service_123",
  "intelligenceConfigurationIds": [
    "agent1",
    "agent2"
  ],
  "conversationsV1Bridge": {
    "serviceId": "IS00000000000000000000000000000000"
  }
}

Response

Accepted - Operation created for asynchronous processing

statusUrlstring uri required

URL to poll for operation status.

relatedobject nullable

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

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

Example response

{
  "statusUrl": "https://conversations.twilio.com/v2/ControlPlane/Operations/proc_job_01h9d8r0vte3hz8tykdj329t7r",
  "related": {
    "configurationId": "cfg_configuration_01h9d8r0vte3hz8tykdj329t7r"
  }
}

Changes