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

UpdateContact

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

Important

You can add or update user-defined contact information for both ongoing and completed contacts.

Request Syntax


POST /contacts/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "CustomerEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "Description": "string",
   "Name": "string",
   "QueueInfo": { 
      "Id": "string"
   },
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "SegmentAttributes": { 
      "string" : { 
         "ValueInteger": number,
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "SystemEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "UserInfo": { 
      "UserId": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

ContactId

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

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

Required: Yes

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

Request Body

The request accepts the following data in JSON format.

CustomerEndpoint

The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Type: Endpoint object

Required: No

Description

The description of the contact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

Name

The name of the contact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

QueueInfo

Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Type: QueueInfoInput object

Required: No

References

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

Type: String to Reference object map

Key Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

SegmentAttributes

A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

Type: String to SegmentAttributeValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

SystemEndpoint

External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Type: Endpoint object

Required: No

UserInfo

Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

Type: UserInfo object

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429