mediatype.delete

Description

object mediatype.delete(array mediaTypeIds)

This method allows to delete media types.

This method is only available to Super admin user type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of the media types to delete.

Return values

(object) Returns an object containing the IDs of the deleted media types under the mediatypeids property.

Examples

Deleting multiple media types

Delete two media types.

Request:

{
           "jsonrpc": "2.0",
           "method": "mediatype.delete",
           "params": [
               "3",
               "5"
           ],
           "auth": "3a57200802b24cda67c4e4010b50c065",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "mediatypeids": [
                   "3",
                   "5"
               ]
           },
           "id": 1
       }

Source

CMediaType::delete() in ui/include/classes/api/services/CMediaType.php.

Documentation