Code example for uploading avatar / profile banner? (v1.1)

[marckohlbrugge]

X API 2.0 does not support uploading an avatar or profile banner, but 1.1 does:
https://developer.x.com/en/docs/x-api/v1/accounts-and-users/manage-account-settings/api-reference/post-account-update_profile_banner

I tried the following:

x_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)

x_client.post("account/update_profile_banner.json", {
  banner: Base64.encode64(File.read("test.png")),
}.to_json)

Which returns the following error:

banner parameter is missing. (X::BadRequest)

---

I also tried this:

x_client.post("account/update_profile_banner.json", {
  banner: Base64.encode64(File.binread("test.png")),
}.to_json, headers: {
  "Content-Type" => "application/json"
})

Which also returns:

banner parameter is missing. (X::BadRequest)

---

I also tried the following:

x_client.post("account/update_profile_banner.json?banner=#{Base64.encode64(File.read("test.png"))}")

Which returns:

Request-URI Too Large (X::HTTPError)

---

I also experimented with code found in #4 (comment) but didn't have any luck there either.

---

Would love a working code example for this. I expect that if we can make it work for the profile banner, we can use a similar approach for uploading avatars which might be a common request.

[sferik]

Did you ever figure out how to upload an avatar or profile banner? If so, would you be willing to contribute the example code? If not, I can work on this when I have some time.

[marckohlbrugge]

@sferik Unfortunately I couldn't figure it out, so I relied on your older twitter gem instead. Would love to switch to x though.

Here's my code with the twitter gem:

x_credentials = {
  # …
}

twitter = Twitter::REST::Client.new do |config|
  config.consumer_key = x_credentials[:api_key]
  config.consumer_secret = x_credentials[:api_key_secret]
  config.access_token = x_credentials[:access_token]
  config.access_token_secret = x_credentials[:access_token_secret]
end

# I'm downloading the image from a URL, but File.binread("test.png") should work the same
image = HTTP.get(url).body
encoded_image = Base64.encode64(image)

twitter.update_profile_banner(encoded_image)

Relevant code:

https://github.com/sferik/twitter-ruby/blob/0570c4f442ce2e4ffae70a2e3536dd690ad120f9/spec/twitter/rest/users_spec.rb#L654-L668

https://github.com/sferik/twitter-ruby/blob/0570c4f442ce2e4ffae70a2e3536dd690ad120f9/lib/twitter/rest/users.rb#L322-L342