Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateTaskTemplate

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

Request Syntax


POST /instance/InstanceId/task/template/TaskTemplateId HTTP/1.1
Content-type: application/json

{
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

TaskTemplateId

A unique identifier for the task template.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Constraints

Constraints that are applicable to the fields listed.

Type: TaskTemplateConstraints object

Required: No

ContactFlowId

The identifier of the flow that runs by default when a task is created by referencing this template.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Defaults

The default values for fields when a task is created by referencing this template.

Type: TaskTemplateDefaults object

Required: No

Description

The description of the task template.

Type: String

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

Required: No

Fields

Fields that are part of the template.

Type: Array of TaskTemplateField objects

Required: No

Name

The name of the task template.

Type: String

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

Required: No

SelfAssignFlowId

The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Status

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "CreatedTime": number,
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Id": "string",
   "InstanceId": "string",
   "LastModifiedTime": number,
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string"
}