Channel/update

From Justin.tv API Wiki

Jump to: navigation, search

Image:Ambox_notice.png Are you building an app that connects with Twitch? Use the Twitch API Instead!

Updates an existing channel. This call requires OAuth authentication for the target channel.

Interface

URL: http://api.justin.tv/api/channel/update.format
Formats: xml, json
Methods: POST, PUT
Authentication: Requires Authentication
Params: POST body must include any parameters to update. Valid parameters are:

  • publisher_guard (a channel password which will make the channel private)
  • anonymous_chatters_allowed
  • title
  • tags
  • category
  • subcategory
  • language
  • status
  • timezone
  • about
  • description
  • channel_text_color
  • channel_link_color
  • channel_background_color
  • channel_column_color
  • profile_image
  • channel_background_image
  • channel_header_image

In order to upload a channel picture, channel header image, or channel background image, set the content header 'multipart/form-data' and send a valid jpg, png or gif in the profile_image, channel_header_image, or channel_background_image param respectively.
You have to keep track of the publisher guard yourself since there's no way to access it through the api.
Returns: Channel Object

Examples

  • You are broadcaster "apidemo" and want to change your channel title and language setting
    • Action
      • url = http://api.justin.tv/api/channel/update.xml
      • method = POST
    • Parameters
      • title = New API Demo
      • language = en
<channel>
 <category>animals</category>
 <id>6285586</id>
 <login>apidemo</login>
 <subcategory>other_animals</subcategory>
 <title>New API Demo</title>
 <tags nil="true"></tags>
 <category_title>Animals</category_title>
 <subcategory_title>Other Animals</subcategory_title>
 <producer>false</producer>
 <language>en</language>
 <timezone>America/Los_Angeles</timezone>
 <channel_url>http://www.justin.tv/apidemo</channel_url>
 <mature nil="true"></mature>
 <image_url_huge>http://static-cdn.justin.tv/jtv_user_pictures/anonymous_monkey-320x240.jpg</image_url_huge>
 <image_url_large>http://static-cdn.justin.tv/jtv_user_pictures/anonymous_monkey-125x94.jpg</image_url_large>
 <image_url_medium>http://static-cdn.justin.tv/jtv_user_pictures/anonymous_monkey-75x56.jpg</image_url_medium>
 <image_url_small>http://static-cdn.justin.tv/jtv_user_pictures/anonymous_monkey-50x37.jpg</image_url_small>
 <image_url_tiny>http://static-cdn.justin.tv/jtv_user_pictures/anonymous_monkey-33x25.jpg</image_url_tiny>
 <screen_cap_url_huge>http://static-cdn.justin.tv/previews/live_user_apidemo-320x240.jpg</screen_cap_url_huge>
 <screen_cap_url_large>http://static-cdn.justin.tv/previews/live_user_apidemo-125x94.jpg</screen_cap_url_large>
 <screen_cap_url_medium>http://static-cdn.justin.tv/previews/live_user_apidemo-75x56.jpg</screen_cap_url_medium>
 <screen_cap_url_small>http://static-cdn.justin.tv/previews/live_user_apidemo-50x37.jpg</screen_cap_url_small>
 <screen_cap_url_tiny>http://static-cdn.justin.tv/previews/live_user_apidemo-33x25.jpg</screen_cap_url_tiny>
 <anonymous_chatters_allowed>false</anonymous_chatters_allowed>
 <about nil="true"></about>
 <description nil="true"></description>
 <blog nil="true"></blog>
 <facebook nil="true"></facebook>
 <myspace nil="true"></myspace>
 <first_color nil="true"></first_color>
 <second_color nil="true"></second_color>
 <text_color nil="true"></text_color>
 <link_color nil="true"></link_color>
 <background_color nil="true"></background_color>
 <header_background_color nil="true"></header_background_color>
 <wrapper_background_color nil="true"></wrapper_background_color>
 <alt_text nil="true"></alt_text>
 <box_background nil="true"></box_background>
 <box_border nil="true"></box_border>
 <chat_border nil="true"></chat_border>
 <h1_color nil="true"></h1_color>
 <h2_color nil="true"></h2_color>
 <embed_code>    <object type="application/x-shockwave-flash" height="295" width="353" id="jtv_player_flash" data="http://www.justin.tv/widgets/jtv_player.swf?channel=apidemo&quot; bgcolor="#000000"><param name="allowFullScreen" value="true" /><param name="allowscriptaccess" value="always" /><param name="movie" value="http://www.justin.tv/widgets/jtv_player.swf&quot; /><param name="flashvars" value="channel=apidemo&auto_play=false&start_volume=25" /></object>
 </embed_code>
</channel>
Client Libraries