v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443311204.0 KB

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Other template APIs are:

post/domains/{domainId}/templates

Path parameters

domainIdstring required

The unique identifier of the Cases domain.

Request body

namestring required

A name for the template. It must be unique per domain.

descriptionstring

A brief description of the template.

status'Active' | 'Inactive'

The status of the template.

Response

Success

templateIdstring required

A unique identifier of a template.

templateArnstring required

The Amazon Resource Name (ARN) of the newly created template.