View source for Site:API:Content

= Content =

== Add Content ==

This API call is responsible for creating a content item.

=== Authentication Restrictions ===

Any authenticated user.

=== Required Parameters ===

* <code>action=addcontent</code>
* <code>type</code>: blog,news,album,inventory,object,product,photoset,project,pledge,playlist,event
* <code>title</code>: the content item title; no more than 1000 characters

=== Optional Parameters ===

* <code>description</code>: the content item description; no more than 65k characters
* <code>release_date</code>: the release date of this content item
* <code>credits_per_minute</code>: the current amount of credits to stream this item on a per minute basis; only applies to videos and songs.
* <code>credits_to_own</code>: the current amount of credits to purchase this item.
* <code>price</code>: the cash value of this item.
:: only available for types that are not a product or project.
* <code>inventory</code>: only available for types that are event.
* <code>label</code>: will be prefixed by the site's user prefix label.
* <code>addcategory</code>: an array of category ids
* <code>addtag</code>: an array of tags
* <code>featured_on_content_id</code>: an advanced feature for featuring products during a live broadcast.
* <code>inventory:stock:quantity</code>: only available for types that are inventory; initializes stock to this value.
* <code>inventory:stock:external_id</code>: only available for types that are inventory; an optional external_id for this stock.
* <code>inventory:stock:external2_id</code>: only available for types that are inventory; an optional external_id for this stock.
* <code>inventory:stock:note</code>: only available for types that are inventory; an optional note for this stock.
* <code>cst_*</code>: custom fields related to content
:: replace the * with the appropriate custom field name

=== Successful Response ===

* <code>status=ok</code>
* <code>item</code>
** <code>contentId</code>: the id of the newly created content item
** <code>canonicalId</code>: the canonical id of the newly created content item.

== Edit Content ==

This API call is responsible for editing a content item.

=== Authentication Restrictions ===

Moderators and Comment authors.

=== Required Parameters ===

* <code>action=editcontent</code>
* <code>contentId</code>: the id of the content item

=== Optional Parameters ===

* <code>title</code>
* <code>description</code>
* <code>access</code>
* <code>release_date</code>
* <code>event_date</code>
* <code>live_host</code>
* <code>live_mode</code>
* <code>preview_offset</code>
* <code>preview_duration</code>
* <code>external_id</code>
* <code>allow_oversell</code>
* <code>price</code>
* <code>price1</code>
* <code>price2</code>
* <code>price3</code>
* <code>price4</code>
* <code>price_formula</code>
* <code>credits_to_own</code>
* <code>credits_per_minute</code>
* <code>commission_ppm_percentage</code>
* <code>commission_pto_percentage</code>
* <code>commission_gift_percentage</code>
* <code>commission_bandwidth_percentage</code>
* <code>review</code>
* <code>gift_credits</code>
* <code>user</code>
* <code>chat_muted</code>
* <code>img:selected</code>
* <code>img:title</code>
* <code>img:position</code>
* <code>photo_hint</code>
* <code>add:relationship</code>
* <code>del:relationship</code>
* <code>playlist:media_id</code>
* <code>image (multipart)</code>
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10 (multipart)</code>
* <code>banner,banner1,banner2,banner3,banner4,banner5,banner6,banner7,banner8,banner9,banner10</code>
* <code>banner:photo,banner1:photo,banner2:photo,banner3:photo,banner4:photo,banner5:photo,banner6:photo,banner7:photo,banner8:photo,banner9:photo,banner10:photo</code>
* <code>banner:screenshot,banner1:screenshot,banner2:screenshot,banner3:screenshot,banner4:screenshot,banner5:screenshot,banner6:screenshot,banner7:screenshot,banner8:screenshot,banner9:screenshot,banner10:screenshot</code>
* <code>inventory</code>
* <code>inventory:stock:quantity</code>
* <code>featured_on_content_id</code>
* <code>tags</code>
* <code>addtag</code>
* <code>deletetag</code>
* <code>categories</code>
* <code>addcategory</code>
* <code>deletecategory</code>
* <code>label</code>
* <code>label_hint</code>
* <code>cst_*</code>: custom fields related to content
:: replace the * with the appropriate custom field name.

=== Successful Response ===

* <code>status=ok</code>
* <code>properties</code>
** <code>pending</code>
** <code>approved</code>