Edit External Media

From KickApps Documentation

Jump to: navigation, search

Contents

Overview

This call lets you edit an external media (emedia).

Note: Currently, this call only supports "emedia". We plan to extend this call in a future release to be able to edit all mediatypes

Your request will look something like the following:

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

Parameters

As shown above, your call will include the following parameters:

  • mediaType. The type of media being edited here. Currently, this call only supports "emedia". We plan to extend this call in a future release to be able to edit all media types
  • mediaId. The id of media that is being edited.
  • as. The site id to search. as is unique for each of the affiliate site.

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".
  • url. Required when mediaType is "emedia". This is the original pathToMedia value provided when Add External Media was called.
  • pathToMedia. Optional. This is the new URL for the emedia. It must be unique - this value will function as the media's unique ID for all subsequent API calls.
  • name. Optional. A text description of this media that will display to members. The text can be no longer than 5000 characters.
  • description. Optional. String. The description of this media object
  • author. Optional. the name of the author of the external media.
  • tags. Optional. 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. New tags should no remove the old tags.
  • admintags. Optional. 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. New tags should no remove the old tags.
  • category. Optional. 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.
  • allowPublicTagging. Optional. true or false. Whether members can tag this media.
  • allowPublicCommenting. Optional. true or false. Default is true. By default, form is set to true. Whether members can comment on this media.
  • country. Optional. The country associated with the external media. The values in your upload form must exactly match those used by KIT Cloud Social. 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. Optional. The abbreviation for the state associated with the external media. The value selected in the upload form will correspond to those shown on Page 169.
  • stateOrProvince. Optional. The abbreviation for the province associated with the external media. The value selected in the upload form will correspond to those shown on Page 169.
  • ausState. Optional. The abbreviation for the external media's state. The value selected in the upload form will correspond to those shown on United States State Values.
  • otherStateOrProvince. The abbreviation for the external media'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.
  • city. Optional. The external media's city. The max character length for this field is 128 characters.
  • zipcode. Optional. the external media'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.

JSON Payload

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

Permissions

Only the affiliate or webmaster should be able to call this call.

List of Kit Cloud Social API Calls


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.