v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the <code>$ACTIVE_VERSION</code> qualifier later to reference the version that is in active status.

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

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 activate.

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 is activated.

All 94 operations