Delete Specified Media

DELETE 
/api/v2/instance/:instanceId/media/:mediaId

Deletes the specified media file associated with a given instance. Ensure that the media has been prepared before deletion.

Request

Path Parameters

mediaId Media IDrequired

Id of the media that was prepared.

instanceId stringrequired

ID of the instance.

Responses

200

MediaResponse

application/json

Schema

Schema

mediaId stringrequired
type stringrequired
filename stringrequired
mimetype stringrequired
path stringrequired
createdAt stringrequired
deletedAt stringrequired
bucketBucketId stringrequired
Message object

messageId stringrequired

keyId stringrequired

keyFromMe booleanrequired

keyRemoteJid stringrequired

keyParticipant stringrequired

pushName stringrequired

contentType stringrequired

isGroup booleanrequired

content objectrequired

source stringrequired

messageTimestamp stringrequired

createdAt date-timerequired

deletedAt date-timerequired

typeOfDeletion stringrequired

Possible values: [everyone, forMe]

Example (from schema)

{
  "mediaId": "string",
  "type": "string",
  "filename": "string",
  "mimetype": "string",
  "path": "string",
  "createdAt": "string",
  "deletedAt": "string",
  "bucketBucketId": "string",
  "Message": {
    "messageId": "string",
    "keyId": "string",
    "keyFromMe": true,
    "keyRemoteJid": "string",
    "keyParticipant": "string",
    "pushName": "string",
    "contentType": "string",
    "isGroup": true,
    "content": {},
    "source": "string",
    "messageTimestamp": "string",
    "createdAt": "2024-04-14T14:11:05.714Z",
    "deletedAt": "2024-04-14T14:11:05.714Z",
    "typeOfDeletion": "everyone"
  }
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...