v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the <code>$ACTIVE_VERSION</code> qualifier to reference the version in active status.

post/knowledgeBases/{knowledgeBaseId}/messageTemplates/{messageTemplateId}/deactivate

Path parameters

knowledgeBaseIdstring required

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

messageTemplateIdstring required

The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

Request body

versionNumberinteger required

The version number of the message template version to deactivate.

Response

Success

messageTemplateArnstring required

The Amazon Resource Name (ARN) of the message template.

messageTemplateIdstring required

The identifier of the message template.

versionNumberinteger required

The version number of the message template version that has been deactivated.