Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443311204.0 KB

Updates the content of a related item associated with a case. The following related item types are supported:

  • Comment - Update the text content of an existing comment

  • Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas.

Important things to know

  • When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.

  • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide.

  • System case fields cannot be used in a custom related item.

Endpoints: See Amazon Connect endpoints and quotas.

put/domains/{domainId}/cases/{caseId}/related-items/{relatedItemId}

Path parameters

domainIdstring required

The unique identifier of the Cases domain.

caseIdstring required

A unique identifier of the case.

relatedItemIdstring required

Unique identifier of a related item.

Request body

Response

Success

relatedItemIdstring required

The unique identifier of the updated related item.

relatedItemArnstring required

The Amazon Resource Name (ARN) of the updated related item.

type'Contact' | 'Comment' | 'File' | 'Sla' | 'ConnectCase' | 'Custom' required

Type of the updated related item.

associationTimestring date-time required

Time at which the related item was associated with the case.

tagsobject

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.