UpdateTemplate - Amazon Connect Cases


Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Request Syntax

PUT /domains/domainId/templates/templateId HTTP/1.1 Content-type: application/json { "description": "string", "layoutConfiguration": { "defaultLayout": "string" }, "name": "string", "requiredFields": [ { "fieldId": "string" } ], "status": "string" }

URI Request Parameters

The request uses the following URI parameters.


The unique identifier of the Cases domain.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes


A unique identifier for the template.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

Request Body

The request accepts the following data in JSON format.


A brief description of the template.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No


Configuration of layouts associated to the template.

Type: LayoutConfiguration object

Required: No


The name of the template. It must be unique per domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^.*[\S]$

Required: No


A list of fields that must contain a value for a case to be successfully created with this template.

Type: Array of RequiredField objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No


The status of the template.

Type: String

Valid Values: Active | Inactive

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 403


The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

HTTP Status Code: 409


We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500


We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

HTTP Status Code: 404


The rate has been exceeded for this API. Please try again after a few minutes.

HTTP Status Code: 429


The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400


Request and Response example

This example illustrates one usage of UpdateTemplate.

{ "name": "updated_template_name" }
{ }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: