DeleteRelatedItem - Amazon Connect

DeleteRelatedItem

Deletes the related item resource under a case.

Note

This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API

Request Syntax

DELETE /domains/domainId/cases/caseId/related-items/relatedItemId HTTP/1.1

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

A unique identifier of the Cases domain.

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

Required: Yes

relatedItemId

A unique identifier of a related item.

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

Required: Yes

Request Body

The request does not have a request body.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: