DeleteWhatsAppMessageMedia - AWS End User Messaging Social
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DeleteWhatsAppMessageMedia

Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.

Request Syntax

DELETE /v1/whatsapp/media?mediaId=mediaId&originationPhoneNumberId=originationPhoneNumberId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

mediaId

The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.

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

Pattern: [A-Za-z0-9]+

Required: Yes

originationPhoneNumberId

The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

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

Pattern: .*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "success": boolean
}

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.

success

Success indicator for deleting the media file.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedByMetaException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400

See Also

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