Skip to content

UpdateQuickResponseRequest

Source code in docs_src/capo_qconnect/types/update_quick_response_request.py
class UpdateQuickResponseRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>"""
    quick_response_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>The identifier of the quick response.</p>"""
    name: NotRequired["capo_qconnect.types.quick_response_name.QuickResponseName"]
    """<p>The name of the quick response.</p>"""
    content: NotRequired[
        "capo_qconnect.types.quick_response_data_provider.QuickResponseDataProvider"
    ]
    """<p>The updated content of the quick response.</p>"""
    content_type: NotRequired[
        "capo_qconnect.types.quick_response_type.QuickResponseType"
    ]
    """<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>"""
    grouping_configuration: NotRequired[
        "capo_qconnect.types.grouping_configuration.GroupingConfiguration"
    ]
    """<p>The updated grouping configuration of the quick response.</p>"""
    remove_grouping_configuration: NotRequired["bool"]
    """<p>Whether to remove the grouping configuration of the quick response.</p>"""
    description: NotRequired[
        "capo_qconnect.types.quick_response_description.QuickResponseDescription"
    ]
    """<p>The updated description of the quick response.</p>"""
    remove_description: NotRequired["bool"]
    """<p>Whether to remove the description from the quick response.</p>"""
    shortcut_key: NotRequired["capo_qconnect.types.short_cut_key.ShortCutKey"]
    """<p>The shortcut key of the quick response. The value should be unique across the knowledge base.</p>"""
    remove_shortcut_key: NotRequired["bool"]
    """<p>Whether to remove the shortcut key of the quick response.</p>"""
    is_active: NotRequired["bool"]
    """<p>Whether the quick response is active. </p>"""
    channels: NotRequired["capo_qconnect.types.channels.Channels"]
    """<p>The Connect Customer contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>"""
    language: NotRequired["capo_qconnect.types.language_code.LanguageCode"]
    """<p>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> </p>"""

channels instance-attribute

channels: NotRequired[Channels]

The Connect Customer contact channels this quick response applies to. The supported contact channel types include Chat.

content instance-attribute

content: NotRequired[QuickResponseDataProvider]

The updated content of the quick response.

content_type instance-attribute

content_type: NotRequired[QuickResponseType]

The media type of the quick response content.

  • Use application/x.quickresponse;format=plain for quick response written in plain text.

  • Use application/x.quickresponse;format=markdown for quick response written in richtext.

description instance-attribute

description: NotRequired[QuickResponseDescription]

The updated description of the quick response.

grouping_configuration instance-attribute

grouping_configuration: NotRequired[GroupingConfiguration]

The updated grouping configuration of the quick response.

is_active instance-attribute

is_active: NotRequired[bool]

Whether the quick response is active.

knowledge_base_id instance-attribute

knowledge_base_id: UuidOrArn

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

language instance-attribute

language: NotRequired[LanguageCode]

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

name instance-attribute

name: NotRequired[QuickResponseName]

The name of the quick response.

quick_response_id instance-attribute

quick_response_id: UuidOrArn

The identifier of the quick response.

remove_description instance-attribute

remove_description: NotRequired[bool]

Whether to remove the description from the quick response.

remove_grouping_configuration instance-attribute

remove_grouping_configuration: NotRequired[bool]

Whether to remove the grouping configuration of the quick response.

remove_shortcut_key instance-attribute

remove_shortcut_key: NotRequired[bool]

Whether to remove the shortcut key of the quick response.

shortcut_key instance-attribute

shortcut_key: NotRequired[ShortCutKey]

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