POST collections/update
post-collections-update

POST collections/update

Update information concerning a Collection owned by the currently authenticated user.

Partial updates are not currently supported: please provide name, description, and url whenever using this method. Omitted description or url parameters will be treated as if an empty string was passed, overwriting any previously stored value for the Collection.

Resource URL

https://api.x.com/1.1/collections/update.json

Resource Information

Response formats JSON
Requires authentication? Yes (user context only)
Rate limited? Yes

Parameters

Name Required Description Default Value Example
id required The identifier of the Collection to modify. custom-388061495298244609
name optional The title of the Collection being created, in 25 characters or fewer. Sweet%20Tweets
description optional A brief description of this Collection in 160 characters or fewer. My%20favorite%20tweets%20ever
url optional A fully-qualified URL to associate with this Collection. https%3A%2F%2Fexample.com%2F

Example Request

POST https://api.x.com/1.1/collections/update.json?name=Subtweets&id=custom-390882285743898624

Example Response

{
  "response": {
    "timeline_id": "custom-390882285743898624"
  },
  "objects": {
    "users": {
      "119476949": {
        "profile_sidebar_fill_color": "DDEEF6",
        "profile_sidebar_border_color": "C0DEED",
        "profile_background_tile": true,
        "name": "OAuth Dancer",
        "profile_image_url": "http://a0.twimg.com/profile_images/730275945/oauth-dancer_normal.jpg",
        "created_at": "Wed Mar 03 19:37:35 +0000 2010",
        "location": "San Francisco, CA",
        "follow_request_sent": null,
        "profile_link_color": "0084B4",
        "is_translator": false,
        "id_str": "119476949",
        "default_profile": false,
        "contributors_enabled": false,
        "favourites_count": 0,
        "url": "http://bit.ly/oauth-dancer",
        "profile_image_url_https": "https://si0.twimg.com/profile_images/730275945/oauth-dancer_normal.jpg",
        "utc_offset": null,
        "id": 119476949,
        "profile_use_background_image": true,
        "listed_count": 0,
        "profile_text_color": "333333",
        "lang": "en",
        "followers_count": 0,
        "protected": false,
        "notifications": null,
        "profile_background_image_url_https": "https://si0.twimg.com/profile_background_images/80151733/oauth-dance.png",
        "profile_background_color": "C0DEED",
        "verified": false,
        "geo_enabled": true,
        "time_zone": null,
        "description": "",
        "default_profile_image": false,
        "profile_background_image_url": "http://a0.twimg.com/profile_background_images/80151733/oauth-dance.png",
        "statuses_count": 0,
        "friends_count": 0,
        "following": null,
        "screen_name": "oauth_dancer",
        "counts": {
          "lists": {
            "owned": null,
            "subscribed": null
          },
          "saved_searches": 0
        }
      }
    },
    "timelines": {
      "custom-390882285743898624": {
        "name": "Subtweets",
        "user_id": "119476949"
      }
    }
  }
}