POST account/update_profile_background_image

API version 1.1
Updated on Wed, 2012-09-05 11:58

Updates the authenticating user's profile background image. This method can also be used to enable or disable the profile background image.

Although each parameter is marked as optional, at least one of image, tile or use must be provided when making this request.

Resource URL

https://api.twitter.com/1.1/account/update_profile_background_image.json

Parameters

image optional

The background image for the profile, base64-encoded. Must be a valid GIF, JPG, or PNG image of less than 800 kilobytes in size. Images with width larger than 2048 pixels will be forcibly scaled down. The image must be provided as raw multipart data, not a URL.

tile optional

Whether or not to tile the background image. If set to true, t or 1 the background image will be displayed tiled. The image will not be tiled otherwise.

include_entities optional

The entities node will not be included when set to false.

Example Values: false

skip_status optional

When set to either true, t or 1 statuses will not be included in the returned user objects.

use optional

Determines whether to display the profile background image or not. When set to true, t or 1 the background image will be displayed if an image is being uploaded with the request, or has been uploaded previously. An error will be returned if you try to use a background image when one is not being uploaded or does not exist. If this parameter is defined but set to anything other than true, t or 1, the background image will stop being used.

Example Request

POST

https://api.twitter.com/1.1/account/update_profile_background_image.json

POST Data

use=1&skip_status=1&tile=1 


  1. {
  2.     "contributors_enabled": false, 
  3.     "created_at": "Thu Aug 23 19:45:07 +0000 2012", 
  4.     "default_profile": false, 
  5.     "default_profile_image": false, 
  6.     "description": "Keep calm and test", 
  7.     "favourites_count": 0, 
  8.     "follow_request_sent": false, 
  9.     "followers_count": 0, 
  10.     "following": false, 
  11.     "friends_count": 10, 
  12.     "geo_enabled": true, 
  13.     "id": 776627022, 
  14.     "id_str": "776627022", 
  15.     "is_translator": false, 
  16.     "lang": "en", 
  17.     "listed_count": 0, 
  18.     "location": "San Francisco, CA", 
  19.     "name": "Sean Test", 
  20.     "notifications": false, 
  21.     "profile_background_color": "9AE4E8", 
  22.     "profile_background_image_url": "http://a0.twimg.com/images/themes/theme16/bg.gif", 
  23.     "profile_background_image_url_https": "https://si0.twimg.com/images/themes/theme16/bg.gif", 
  24.     "profile_background_tile": false, 
  25.     "profile_image_url": "http://a0.twimg.com/profile_images/2550256790/hv5rtkvistn50nvcuydl_normal.jpeg", 
  26.     "profile_image_url_https": "https://si0.twimg.com/profile_images/2550256790/hv5rtkvistn50nvcuydl_normal.jpeg", 
  27.     "profile_link_color": "0084B4", 
  28.     "profile_sidebar_border_color": "BDDCAD", 
  29.     "profile_sidebar_fill_color": "DDFFCC", 
  30.     "profile_text_color": "333333", 
  31.     "profile_use_background_image": true, 
  32.     "protected": false, 
  33.     "screen_name": "s0c1alm3dia", 
  34.     "show_all_inline_media": false, 
  35.     "statuses_count": 0, 
  36.     "time_zone": "Pacific Time (US & Canada)", 
  37.     "url": "http://cnn.com", 
  38.     "utc_offset": -28800, 
  39.     "verified": false
  40. }