POST lists/members/destroy_all
post-lists-members-destroy_all

POST lists/members/destroy_all

Removes multiple members from a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to remove members from it. Note that lists can't have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method.

Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.

Resource URL

https://api.x.com/1.1/lists/members/destroy_all.json

Resource Information

Response formats JSON
Requires authentication? Yes
Rate limited? Yes

Parameters

Name Required Description Default Value Example
list_id required The numerical id of the list.
slug required You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.
user_id optional A comma separated list of user IDs, up to 100 are allowed in a single request.
screen_name optional A comma separated list of screen names, up to 100 are allowed in a single request.
owner_screen_name optional The screen name of the user who owns the list being requested by a slug .
owner_id optional The user ID of the user who owns the list being requested by a slug .

Example Request

POST https://api.x.com/1.1/lists/members/destroy_all.json?screen_name=rsarver,episod,jasoncosta,theseancook,kurrik,froginthevalley&list_id=23

Example Response