--- title: "Update an Intelligence Configuration" method: PUT path: "/v3/ControlPlane/Configurations/{id}" tags: ["Configurations"] --- # Update an Intelligence Configuration `PUT /v3/ControlPlane/Configurations/{id}` Update an Intelligence Configuration, including its metadata and rules. The request must include all required fields. ## Request body - object - `displayName` string, required — The display name of the Intelligence Configuration describing its purpose. - `description` string — The description of the Intelligence Configuration further explaining its purpose. - `rules` RuleUpdateRequestPayload[], required — List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. - `id` string — Optional field used when updating an existing Rule within an Intelligence Configuration. When provided, the Rule with this `id` is updated; when omitted, a new Rule is created. - `operators` Operator[], required — List of Operators to be executed by the Rule. Minimum of one (1) and maximum of five (5) Operators allowed per Rule. - `id` string, required — The unique identifier for the Language Operator to be executed by the Rule. Assigned by Twilio (TTID). - `version` integer — The specific version of the Language Operator to execute. When provided, the Rule will use this exact version of the Operator. When omitted, the latest active version of the Operator is used at execution time. - `parameters` object — Key-value mapping for parameters defined as part of the Operator schema. The key and value passed by the Rule must match the name and data type of the parameter defined in the Operator, respectively. These parameters will customize the behavior of the Operator when executed by the Rule via runtime substitution into the prompt. Note: For parameters of type `knowledge_base_and_source_ids`, the value must be passed in the following format: `knowledge_base_id:knowledge_source_id`. - `triggers` Trigger[] — List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule. - `on` 'COMMUNICATION' | 'CONVERSATION_END' | 'CONVERSATION_INACTIVE', required — The conversational lifecycle event that will activate execution of the Rule. Available values are: - `COMMUNICATION`: Trigger the Rule on each communication within the Conversation. - `CONVERSATION_END`: Trigger the Rule when the Conversation moves to the `closed` state - `CONVERSATION_INACTIVE`: Trigger the Rule when the Conversation moves to `inactive` state - `parameters` object — Additional configuration to modify Trigger behavior. Only applies to certain Trigger types. - `count` integer — When `on` is set to `COMMUNICATION`, this value controls how often the Rule should run. A value of `1` executes the Rule for every communication event. Higher values delay execution until the specified number of communications have occurred since the last execution. - `actions` Action[], required — List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule. - `type` 'WEBHOOK', required — The type of Action to be performed after the Rule is triggered. Supported Actions are: - `WEBHOOK`: A webhook Action sends an HTTP request to a specified URL with Rule execution results. - `method` 'POST', required — The HTTP method to be used when performing the Action. Must be set to `POST`. - `url` string, uri, required — The URL endpoint where the Action will send the HTTP request containing the Rule execution results. - `context` Context — Controls what additional customer and enterprise context is made available to Language Operators when this Rule executes. - `memory` object — Configuration for passing Memory as context to Operators in this Rule (available only for Memory–enabled accounts). - `enabled` boolean — When set to `true`, allows this Intelligence Configuration Rule to pass the Profile into attached Language Operators. The profile is only passed to Language Operators that have Memory as a context source enabled. - `knowledge` object — Configuration for passing Enterprise Knowledge as context to Operators in this Rule (available only for Enterprise Knowledge–enabled accounts). - `bases` string[], required — Specifies the Knowledge Base(s) and corresponding Source(s) to pass to Language Operators in this Rule as context. Only applied to Language Operators that have Knowledge as a context source enabled. ## Response `200` Intelligence configuration resource updated. - object — An Intelligence Configuration defines how and when Language Operators execute for a given conversation. To activate an Intelligence Configuration and trigger Operator execution, two conditions must be met: 1. The Intelligence Configuration must include at least one Rule. 2. The Intelligence Configuration must be attached to a Conversations Configuration via the Conversations API. Conversation traffic received by that Conversations Configuration determines when Rules are evaluated and executed. An Intelligence Configuration that has no Rules or is not attached to a Conversations Configuration will not execute. - `accountId` string, required — The ID of the Account that created the Intelligence Configuration. - `id` string, required — The unique identifier for the Intelligence Configuration. Assigned by Twilio (TTID). - `displayName` string, required — The display name of the Intelligence Configuration describing its purpose. - `description` string — The description of the Intelligence Configuration further explaining its purpose. - `version` integer, required — The numeric version of the Intelligence Configuration. Automatically incremented with each update on the resource, used to ensure integrity when updating the Configuration. - `rules` Rule[], required — List of Intelligence Configuration Rules that govern when and how Language Operators run. Each Rule represents a bundle of Operators, Triggers, Context, and Actions to be executed by the Intelligence Configuration on a Conversation. A maximum of five (5) Rules are allowed per Intelligence Configuration. - `id` string, required — The unique identifier for the Rule. Assigned by Twilio (TTID). - `operators` Operator[], required — List of Operators to be executed by the Rule. Maximum of five (5) Operators allowed per Rule. - `id` string, required — The unique identifier for the Language Operator to be executed by the Rule. Assigned by Twilio (TTID). - `version` integer — The specific version of the Language Operator to execute. When provided, the Rule will use this exact version of the Operator. When omitted, the latest active version of the Operator is used at execution time. - `parameters` object — Key-value mapping for parameters defined as part of the Operator schema. The key and value passed by the Rule must match the name and data type of the parameter defined in the Operator, respectively. These parameters will customize the behavior of the Operator when executed by the Rule via runtime substitution into the prompt. Note: For parameters of type `knowledge_base_and_source_ids`, the value must be passed in the following format: `knowledge_base_id:knowledge_source_id`. - `triggers` Trigger[], required — List of Triggers that determine when to activate the Rule. Maximum of one (1) Trigger allowed per Rule. - `on` 'COMMUNICATION' | 'CONVERSATION_END' | 'CONVERSATION_INACTIVE', required — The conversational lifecycle event that will activate execution of the Rule. Available values are: - `COMMUNICATION`: Trigger the Rule on each communication within the Conversation. - `CONVERSATION_END`: Trigger the Rule when the Conversation moves to the `closed` state - `CONVERSATION_INACTIVE`: Trigger the Rule when the Conversation moves to `inactive` state - `parameters` object — Additional configuration to modify Trigger behavior. Only applies to certain Trigger types. - `count` integer — When `on` is set to `COMMUNICATION`, this value controls how often the Rule should run. A value of `1` executes the Rule for every communication event. Higher values delay execution until the specified number of communications have occurred since the last execution. - `actions` Action[], required — List of Actions to be performed after the Rule is triggered. Maximum of two (2) Actions allowed per Rule. - `type` 'WEBHOOK', required — The type of Action to be performed after the Rule is triggered. Supported Actions are: - `WEBHOOK`: A webhook Action sends an HTTP request to a specified URL with Rule execution results. - `method` 'POST', required — The HTTP method to be used when performing the Action. Must be set to `POST`. - `url` string, uri, required — The URL endpoint where the Action will send the HTTP request containing the Rule execution results. - `context` Context — Controls what additional customer and enterprise context is made available to Language Operators when this Rule executes. - `memory` object — Configuration for passing Memory as context to Operators in this Rule (available only for Memory–enabled accounts). - `enabled` boolean — When set to `true`, allows this Intelligence Configuration Rule to pass the Profile into attached Language Operators. The profile is only passed to Language Operators that have Memory as a context source enabled. - `knowledge` object — Configuration for passing Enterprise Knowledge as context to Operators in this Rule (available only for Enterprise Knowledge–enabled accounts). - `bases` string[], required — Specifies the Knowledge Base(s) and corresponding Source(s) to pass to Language Operators in this Rule as context. Only applied to Language Operators that have Knowledge as a context source enabled. - `dateCreated` string, date-time, required — Timestamp of when the Intelligence Configuration was created. - `dateUpdated` string, date-time, required — Timestamp of when the Intelligence Configuration was last updated. ## Other responses - `400` — Bad request - `404` — Resource not found - `500` — Internal server error --- [API](https://skmtc.net/twilio/apis/twilio-intelligence.md) · [All operations](https://skmtc.net/twilio/apis/twilio-intelligence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/twilio/twilio-intelligence/revisions/3a830979326d/schema)