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

UpdateCase

Note

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .

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

Request Syntax


PUT /domains/domainId/cases/caseId HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

caseId

A unique identifier of the case.

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

Required: Yes

domainId

The unique identifier of the Cases domain.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

fields

An array of objects with fieldId (matching ListFields/DescribeField) and value union data, structured identical to CreateCase.

Type: Array of FieldValue objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: Yes

performedBy

Represents the identity of the person who performed the action.

Type: UserUnion object

Note: This object is a Union. Only one member of this object can be specified or returned.

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 access to perform this action.

HTTP Status Code: 403

InternalServerException

We couldn't process your request because of an issue with the server. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.

HTTP Status Code: 404

ThrottlingException

The rate has been exceeded for this API. Please try again after a few minutes.

HTTP Status Code: 429

ValidationException

The request isn't valid. Check the syntax and try again.

HTTP Status Code: 400

Examples

Request and Response example

This example illustrates one usage of UpdateCase.


{
  "fields": [
    {
      "id": "title",
      "value": {
        "stringValue": "New Title"
        }
      }
  ]
}

{ }