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

UpdateContactEvaluation

Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ({}) to the question identifier.

Request Syntax


POST /contact-evaluations/InstanceId/EvaluationId HTTP/1.1
Content-type: application/json

{
   "Answers": { 
      "string" : { 
         "Value": { ... }
      }
   },
   "Notes": { 
      "string" : { 
         "Value": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

EvaluationId

A unique identifier for the contact evaluation.

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

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.

Answers

A map of question identifiers to answer value.

Type: String to EvaluationAnswerInput object map

Map Entries: Maximum number of 100 items.

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

Required: No

Notes

A map of question identifiers to note value.

Type: String to EvaluationNote object map

Map Entries: Maximum number of 100 items.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EvaluationArn": "string",
   "EvaluationId": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

EvaluationArn

The Amazon Resource Name (ARN) for the contact evaluation resource.

Type: String

EvaluationId

A unique identifier for the contact evaluation.

Type: String

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

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

ResourceConflictException

A resource already has that name.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

The following example updates a previously started contact evaluation.

Sample Request


{
   "InstanceId": "[instance_id]",
   "EvaluationId": "[evaluation_id]",
   "Answers": {
      "question-1-111": {
         "Value": {
            "StringValue": "question-answer-1-111"
         }
      },
      "question-1-222": {
         "Value": {
            "StringValue": "third-option"
         }
      },
      "question-2-1": {
         "Value": {
            "StringValue": "question-custom-answer-2-1"
         }
      },
      "question-2-222": {
         "Value": {
            "NumericValue": 12
         }
      }
   },
    "Notes": {
      "question-1-111": {
         "Value": "question-1-111 notes"
      },
      "question-2-222": {
         "Value": "question-2-222 notes"
      },
      "section-1": {
         "Value": "section-1 notes"
      },
      "section-2": {
         "Value": "section-2 notes"
      }
   }
}

Sample Response


{
   "EvaluationId": "[evaluation_id]",
   "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]"
}