API Reference


Sets the moderation status for a file.

Visit the article about moderation for more information.


bool media.setModerationStatus ( mixed id, int status, text note = '' )


NameTypeRequiredDefault valueDescription
idmixedRequirednonemedia id: can be an integer or an array of media id's
statusintRequirednonenew moderation status
notetextOptional''additional note to be added to the file


List of fields needed to update the moderation status of a media item.

NameTypeDescriptionPossible Values
idINTThe ID of the media item you wish to update its moderation status. Multiple files can be moderated at once by specifying an array for the id, instead of an integer.INT MID
statusINTThe new moderation status of the media item you are updating. More information available on moderationStatus in our glossary.

Media Moderation Notifications:
Media moderation notification emails can be sent when media is approved or denied. To send these emails, set the `Approved Moderation Email` and `Denied Moderation Email` templates in the channeldetail page of the channel that the media are in.


The response result on successful completion of the updating the status of a media item.

resultThe response from the request.1<error><message>We could not find the file with id: MID</message><type>FileMobile_Storage_FileNotFoundException</type><code>0</code></error>

Sample Response

Sample REST Response
<?xml version="1.0" encoding="UTF-8"?>
Sample JSON Response
    "status": true,
    "result": 1

Code examples


Be the first to comment on setModerationStatus.

Add a Comment

  • captcha