Delete Media

From KickApps Documentation

Contents 1 url 2 Post Parameters 3 Payload 4 Permissions

url

http://api.kickapps.com/rest/deletemedia/{as}

Post Parameters

• t. String. Required. Your access permissions. (Webmaster or Admin only where Admin can't delete a webmaster's media)
• callback. String. Optional. The name of your JavaScript callback function.
• clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".
• mediaType. Supported media types: audio, blog, emedia, page, photo, sets, video and page.
• mediaId. The media Id of the media that is being deleted.
• url. (optional, only for use with emedia) The url of the external media to be deleted. Note: When deleting emedia, you can provide either the media's url or the media's mediaId. If both are provided, the mediaId will take precedence. (May result in an error: "status":"-1", "message":"media not found").

Payload

On success, return a response that begins with "status":"1" and the following "message": "media deleted successfully: {mediaId}".

If the token is invalid (or does not belong to the webmaster or admin) return the following error: "status":"-1", "message":"Invalid token"

If the mediaId is not found return an error that starts with "status":"-1", "message":"media not found. Please check the information provided."

If the mediaId references a custom page that is currently the home page, return the following error: "status":"-1", "message":"You cannot delete your current home page."

If you do not have the correct permission level for this command the following error is returned: "Insufficient user permissions for this operation".

Permissions

Only the affiliate or admin can delete media.