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

{
   "Description": "string",
   "Name": "string",
   "References": { 
      "string" : { 
         "Type": "string",
         "Value": "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.

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 512.

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

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.

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