Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Initiates a flow to start a new task.

put/contact/task

Request body

InstanceIdstring required

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.

PreviousContactIdstring

The identifier of the previous chat, voice, or task contact.

ContactFlowIdstring
<p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>
Attributesobject
<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>
Namestring required

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

Referencesobject

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Descriptionstring

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

ClientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

ScheduledTimestring date-time

The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

TaskTemplateIdstring

A unique identifier for the task template.

QuickConnectIdstring

The identifier for the quick connect.

RelatedContactIdstring

The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact.

Response

Success

ContactIdstring

The identifier of this contact within the Amazon Connect instance.