🎉 Pipedream raises $20M Series A 🎉
Read the blog post and TC Techcrunch article.
← Twitter

Add User To List with Twitter API

Pipedream makes it easy to connect APIs for Twitter and 700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add User To List with the Twitter API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Add User To List with the Twitter API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add User To List action
    1. Connect your Twitter account
    2. Select a List
    3. Optional- Configure User ID
    4. Optional- Configure Screen Name
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger


This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add User To List on Twitter
Description:Add a member to a list. The authenticated user must own the list to be able to add members to it. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create)


import twitter from "../../twitter.app.mjs";

export default {
  key: "twitter-add-user-to-list",
  name: "Add User To List",
  description: "Add a member to a list. The authenticated user must own the list to be able to add members to it. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/post-lists-members-create)",
  version: "0.0.1",
  type: "action",
  props: {
    list: {
      propDefinition: [
    userId: {
      propDefinition: [
      optional: true,
    screenName: {
      propDefinition: [
      optional: true,
  async run({ $ }) {
    const {
    } = this;

    if (!userId && !screenName) {
      throw new Error("This action requires either User ID or Screen Name. Please enter one or the other above.");

    const { screen_name: ownerScreenName } = await this.twitter.verifyCredentials({

    const params = {
      slug: list,
    if (userId) params.userId = userId;
    if (screenName) params.screenName = screenName;

    const res = await this.twitter.addUserToList({

    $.export("$summary", "User successfully added to the list");
    return res;


This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
TwittertwitterappThis component uses the Twitter app.
ListliststringSelect a value from the drop down menu.
User IDuserIdstring

The numerical ID of the user to lookup

Screen NamescreenNamestring

The screen name of the user (e.g., pipedream)


Twitter uses OAuth authentication. When you connect your Twitter account, Pipedream will open a popup window where you can sign into Twitter and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Twitter API.

Pipedream requests the following authorization scopes when you connect your account:

About Twitter

From breaking news and entertainment to sports and politics, get the full story with all the live commentary.