user.deletemedia

Description

object user.deletemedia(string/array mediaIds)

This method allows to delete media.

This method is deprecated and will be removed in the future. Please use user.update instead.

Parameters

(string/array) IDs of the media to delete.

Return values

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

Examples

Deleting multiple media

Delete two media.

Request:

{
    "jsonrpc": "2.0",
    "method": "user.deletemedia",
    "params": [
        "11",
        "13"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "mediaids": [
            "11",
            "13"
        ]
    },
    "id": 1
}

See also

• user.update

• user.updatemedia

Source

CUser::deleteMedia() in frontends/php/include/classes/api/services/CUser.php.