Edit Media Meta Data

From KickApps Documentation

Contents 1 Overview 2 Parameters 3 Post Parameters 4 Payload 5 List of KickApps API Calls

Overview

This call enables you to edit the meta data associated with a media item.

Your request will look something like the following:

http://api.kickapps.com/rest/media/edit/{mediaType}/{mediaId)/{as} 

Parameters

• mediaType. Suported media types: audio, video, photo and blogs
• mediaId. The media id for the media whose meta is being edited.
• as. The site that this media id is associated with. as is unique for each of the affiliate's sites.

Post Parameters

• t. String. Required. Your access permissions.
• 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".
• name. Optional. The name for this media. Max length 125 characters.
• title.
• author.
• description. Optional. A text description of this media that will display to members. The text can be no longer than 5000 characters.
• pathToMedia.
• pathToPreview.
• allowPublicTagging. true or false. Whether members can tag this media.
• allowPublicCommenting. true or false. Default is true. By default, form is set to true. Whether members can comment on this media.
• tags. One or more comma-separated keyword tags. Enclose multi-word tags inside quotations ("tag tag",tag). You can also add tags to an existing media item using the separate Add Tags call.

Each mediaId can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.

• admintags. You can only add additional tags using this parameter. To remove tags use the remove Admin Tags Call. One or more comma-separated tags. You must be logged in as an administrator in order to add admin tags. Enclose multi-word tags inside quotations ("tag tag",tag). Each mediaId can have a maximum of 512 characters of associated tags, including the commas that separate each tag. Each tag must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words. Tags cannot include special characters, only letters, numbers, and spaces.
• country. The member's country. The values in your upload form must exactly match those used by KickApps. Geographic Values for Media Uploads

If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated.

• state. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on the Geographic Values for Media Uploads page.
• zipcode. The member's zip or postal code. The max character length for this field is 32 characters. If country is 1 for the United States of America, 2 for Canada, or 15 for Australia, the value for the Zip or Postal Code field will also be validated
• category. Up to three levels of categories that members can use to find this media, written in the following format level1name/level2name/level3name. Level names should be preexisting categories for this site. An error will be returned if you try to add a category that does not already exist.
• stateOrProvince. The abbreviation for the member's province. The value selected in the upload form will correspond to those shown on the Geographic Values for Media Uploads page.
• AusState. The abbreviation for the member's state. The value selected in the upload form will correspond to those shown on United States State Values.
• city. The member's city. The max character length for this field is 128 characters.
• otherStateOrProvince. The abbreviation for the member's state or province if country is not 1 for the United States of America, 2 for Canada, or 15 for Australia. Zip and postal codes are not validated for these values.
• isPrivacyEnabled. True or False. True if the media is private. False if media is public.
• updatedAt. Optional. The date on which the group should be marked as modified. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm
• createdAt. Optional. The date on which the group should be marked as created. If its not passed the the time this call is made will be used. Format: mm/dd/yyyy hh:mm
• isAddToMediaSetAllowed. True or False. True if other community members can add this media to their sets. False if other community members are not permitted to add this media to their sets.

Payload

On success, a return that begins with "status":1,"message":"Media updated successfully.".

List of KickApps API Calls

API Change Log Create Token Call Social Networking Retrieve Member Profile Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" Retrieve User by Facebook Id KickConnect Assign Member Profile Photo Remove Member Profile Photo Member Profile Edit/Update SSO Method Member Register SSO Method Combined Member Sign On and Register SSO Method Member Change Username SSO Method Member Change Email SSO Method OpenAuth Create Message Board Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Delete Member Media Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Retrieve Related Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads Get Video Thumbnails Set Video Thumbnail Blogging Add Blog Post Edit Blog Post Comments and Rating Add External Media Retrieve External Media Edit External Media Add Group Comment Add Media Comment Add Profile Comment Retrieve Comments Search Comments Edit Comment Edit Group Comment Delete Comment Delete Group Comment Flag Comment Flag Group Comment Rate Media Retrieve Media Ratings Retrieve Media Rated By Member Retrieve Likes By User ID Search Search Media Sets Add Media Set Edit Set Retrieve Set Delete Set Add Media to Set Remove Media from Set Groups Add Group Retrieve Group Page Edit Group Request A Group Add/Remove Media To Group Add/Remove Member To Group Retrieve Member Groups Upload Group Photo Remove Group Photo Polls Creating Polls Using the Tag API’s

Contests Add Contest Edit Contest View Contest Retrieve All Contests Add Contest Entry Edit Contest Entry Remove Contest Entry View Contest Entry Retrieve Entries for Contest Select Contest Winner Flag Contest Entry Points and Levels Add to Member Offset Retrieve Member Points Set Member Custom Level Set Member Offset Badges Add Badge Edit Badge List Badges Add Action List Actions Add Badge Requirement Edit Badge Requirement List Badge Requirements Add User Action Retrieve User's Badges Retrieve User's Badge Status Retrieve Super Fans Get Super Fan Ranking Set Super Fan Badge Criteria Categories and Tags Add Tags To Media, Members and Groups Remove Tags From Media, Members and Groups Add Admin Tags To Media, Members and Groups Remove Admin Tags From Media, Members and Groups Retrieve Admin Tags Retrieve Tag Count Add Category Edit Category Retrieve Category Delete Category Add Custom Meta Data Remove Custom Meta Data Retrieve Custom Meta Data Member and Media Management Approve Member Reject Member Approve Member Media Reject Member Media Delete Member Media Retrieve Pending Media Retrieve Active Member Count Retrieve Site Settings CRM Connectors KickApps SugarCRM Connector KickApps Salesforce Connector CRM Connectors (COMING SOON!!) IBM Websphere Microsoft Dynamic CRM NetSuite Oracle CRM On Demand Oracle E-Business Suite CRM PeopleSoft Enterprise CRM Oracle Siebel CRM SAP CRM Sugar Professional Maximizer CRM Pegasystems Customer Process Manager

Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.