v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Updates an existing Amazon Q in Connect quick response.

post/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}

Path parameters

knowledgeBaseIdstring required

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

quickResponseIdstring required

The identifier of the quick response.

Request body

namestring

The name of the quick response.

contentTypestring
<p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p> </li> </ul>
removeGroupingConfigurationboolean

Whether to remove the grouping configuration of the quick response.

descriptionstring

The updated description of the quick response.

removeDescriptionboolean

Whether to remove the description from the quick response.

shortcutKeystring

The shortcut key of the quick response. The value should be unique across the knowledge base.

removeShortcutKeyboolean

Whether to remove the shortcut key of the quick response.

isActiveboolean

Whether the quick response is active.

channelsChannel[]

The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.

languagestring

The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code>

Response

Success