v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443311204.0 KB

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

post/domains/{domainId}/fields

Path parameters

domainIdstring required

The unique identifier of the Cases domain.

Request body

namestring required

The name of the field.

type'Text' | 'Number' | 'Boolean' | 'DateTime' | 'SingleSelect' | 'Url' | 'User' required

Defines the data type, some system constraints, and default display of the field.

descriptionstring

The description of the field.

Response

Success

fieldIdstring required

The unique identifier of a field.

fieldArnstring required

The Amazon Resource Name (ARN) of the field.