Uploads a profile banner on behalf of the authenticating user. For best results, upload an <5MB image that is exactly 1252px by 626px. Images will be resized for a number of display options. Users with an uploaded profile banner will have a profile_banner_url node in their Users objects. More information about sizing variations can be found in User Profile Images and Banners.
Profile banner images are processed asynchronously. The profile_banner_url and its variant sizes will not necessary be available directly after upload.
This method does not yet have a v1.1 equivalent, but will soon.
Resource URL
Parameters
The Base64-encoded or raw image data being uploaded as the user's new profile banner.
The width of the preferred section of the image being uploaded in pixels. Use with height, offset_left, and offset_top to select the desired region of the image to use.
The height of the preferred section of the image being uploaded in pixels. Use with width, offset_left, and offset_top to select the desired region of the image to use.
The number of pixels by which to offset the uploaded image from the left. Use with height, width, and offset_top to select the desired region of the image to use.
The number of pixels by which to offset the uploaded image from the top. Use with height, width, and offset_left to select the desired region of the image to use.
Note: If providing any one of the height, width, offset_left, or offset_top parameters, you must provide all of the sizing parameters.
Extended description
HTTP Response Codes
| Code(s) | Meaning |
|---|---|
| 200, 201, 202 | Profile banner image succesfully uploaded |
| 400 | Either an image was not provided or the image data could not be processed |
| 422 | The image could not be resized or is too large. |
Example Request
| POST | |
| POST Data | |