A Facebook friend list. This object represents the list itself and not the members of the list. The User object has a friendlists connection
To read a FriendList, issue an HTTP GET request to /FRIENDLIST_ID with the read_friendlists permission.
| Name | Description | Permissions | Returns |
id | The friend list ID |
|
|
name | The name of the friend list |
|
|
list_type | The type of the friends list; Possible values are: |
|
|
You can create a FriendList for a user by issuing an HTTP POST request to PROFILE_ID/friendlists with the manage_friendlists permissions and the following parameter:
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Friend list name. Maximum length is 25 characters | string |
yes |
If the create is successful, you get the following return.
| Name | Description | Type |
|---|---|---|
id |
The new friend list ID | string |
You can delete a FriendList for a user by issuing an HTTP DELETE request to /FRIENDLIST_ID with the manage_friendlists permission.
The HTTP request will return true if the delete succeeded, or false otherwise.
| Name | Description | Permissions | Returns |
| members | All of the users who are members of this list. |
| An array of objects containing friend |
You can add multiple users to a FriendList in a single request by issuing an HTTP POST request to /FRIENDLIST_ID/members and setting the members parameter to a comma-separated list of USER_IDs. An example request would look like /FRIENDLIST_ID/members?members=1,2,3. Alternatively, a single user can be added by issuing an HTTP POST request to /FRIENDLIST_ID/members/USER_ID. These operations require the manage_friendlists permission.
For adding multiple users to the same list, using the single request call is preferred for performance reasons.
| Parameter | Description | Type | Required |
|---|---|---|---|
members |
Comma separated list of USER_IDs. | string |
yes |
If the add is successful, the following will be returned.
| Description | Type |
|---|---|
| If the add succeeded | boolean |
You can remove multiple users from a FriendList in a single request by issuing an HTTP DELETE request to /FRIENDLIST_ID/members and setting the members parameter to a comma-separated list of USER_IDs. An example request would look like /FRIENDLIST_ID/members?members=1,2,3. Alternatively, a single user can be removed by issuing an HTTP DELETE request to /FRIENDLIST_ID/members/USER_ID. These operations require the manage_friendlists permission.
For deleting multiple users from the same list, using the single request call is preferred for performance reasons.
| Parameter | Description | Type | Required |
|---|---|---|---|
members |
Comma separated list of USER_IDs. | string |
yes |
If the delete is successful, the following will be returned.
| Description | Type |
|---|---|
| If the delete succeeded | boolean |