Own AWS? Customize your docs with AI search, analytics, and more.

POST

/instance/{InstanceId}/task/template/{TaskTemplateId}

http://connect.{region}.amazonaws.com/instance/{InstanceId}/task/template/{TaskTemplateId}

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.

Access Token Required: API Key

Path Parameters

TaskTemplateIdstringrequired

A unique identifier for the task template.

InstanceIdstringrequired

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

Body Params

Namestring

The name of the task template.

Fieldsarray

Fields that are part of the template.

Statusstring

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

Defaultsobject

Describes default values for fields on a template.

Constraintsobject

Describes constraints that apply to the template fields.

Descriptionstring

The description of the task template.

ContactFlowIdstring

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://connect.{region}.amazonaws.com/instance/{InstanceId}/task/template/{TaskTemplateId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}