Blocks/create
« Return to the list of API methods
Contents |
URL
http://yourserver/api/blocks/create.format
Description
Blocks the specified user. When you block an user, the friendship between the users (if it exists) will be destroyed. Also, blocked users won't be able to follow you or see your notes.
Available formats
XML, JSON
HTTP Method
POST
Requires authentication
YES
Optional parameters
These parameters can be passed through GET or POST.
- ID: The ID or username of the user you want to block. Example: http://yourserver/api/blocks/create/2.xml
- screen_name: The username of the user you want to block. Example: http://yourserver/api/blocks/create.json?screen_name=abcded
- user_id: The user ID of the user you want to block. Example: http://yourserver/api/blocks/create.xml?user_id=2
Return example (XML)
curl http://yourserver/blocks/create.xml?id=lorena -d ""
<?xml version="1.0" encoding="UTF-8"?> <user> <id>2</id> <name>lorena</name> <screen_name>lorena</screen_name> <location/> <description/> <profile_image_url>http://yourserver/static/img/avatar/default_note.png</profile_image_url> <url/> <protected>true</protected> <followers_count>0</followers_count> <created_at>Sat May 15 12:00:07 +0000 2010</created_at> <favourites_count>0</favourites_count> <statuses_count>1</statuses_count> <friends_count>0</friends_count> <following>false</following> <utc_offset/> <geo_enabled>false</geo_enabled> <time_zone/> <profile_background_image_url>http://yourserver/themes/transparency/img/bg.png</profile_background_image_url> <profile_background_tile>false</profile_background_tile> <notifications>false</notifications> <verified>false</verified> <lang>en</lang> <contributors_enabled>false</contributors_enabled> <status> <created_at>Sat May 15 12:00:42 +0000 2010</created_at> <id>5</id> <text>test</text> <source>web</source> <truncated>false</truncated> <in_reply_to_status_id/> <in_reply_to_user_id/> <favorited>false</favorited> <in_reply_to_screen_name/> </status> </user>
Return example (JSON)
curl http://yourserver/blocks/create.json?id=lorena -d ""
{ "id": 2, "name": "lorena", "screen_name": "lorena", "location": null, "description": "", "profile_image_url": "http:\/\/yourserver\/static\/img\/avatar\/default_note.png", "url": null, "protected": true, "followers_count": "0", "created_at": "Sat May 15 12:00:07 +0000 2010", "favourites_count": 0, "statuses_count": "1", "friends_count": "0", "following": false, "utc_offset": null, "time_zone": null, "profile_background_image_url": "http:\/\/yourserver\/themes\/transparency\/img\/bg.png", "profile_background_tile": false, "notifications": false, "verified": false, "lang": "en", "contributions_enabled": false, "geo_enabled": false, "status": { "created_at": "Sat May 15 12:00:42 +0000 2010", "id": "5", "source": "web", "truncated": false, "in_reply_to_status_id": null, "in_reply_to_user_id": null, "favorited": false, "in_reply_to_screen_name": null, "text": "test" } }
