# Create Worksheet — Microsoft Excel

> Add a new worksheet (tab) to an existing Excel workbook. See the documentation

- Key: `microsoft_excel-create-worksheet`
- Type: Action (Write)
- Version: 0.0.1
- App: Microsoft Excel (`microsoft_excel`) — https://pipedream.com/apps/microsoft-excel.md
- This page (HTML): https://pipedream.com/apps/microsoft-excel/actions/create-worksheet
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/microsoft_excel/actions/create-worksheet/create-worksheet.mjs

## Description

Add a new worksheet (tab) to an existing Excel workbook. [See the documentation](https://learn.microsoft.com/en-us/graph/api/worksheetcollection-add?view=graph-rest-1.0&tabs=http)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `folderId` | `string` | No | Optional. Only narrows the Workbook list below to one folder — it is NOT needed to add the worksheet. If you already have the workbook's item ID (e.g. from Create Workbook), skip this and pass it directly as Workbook. Use List Folder ID Options to find a folder ID (the value field). E.g. 01BYE5RZ6QN3ZWBTRWFNG2FOD7ONP4JLHU Options are loaded from the connected account. |
| `sheetId` | `string` | Yes | The workbook to add the worksheet to — its OneDrive drive-item ID. Pass an ID you already have (e.g. the id returned by Create Workbook); no folder needed. E.g. 01BYE5RZ6QN3ZWBTRWFNG2FOD7ONP4JLHU Options are loaded from the connected account. |
| `name` | `string` | No | The name for the new worksheet (tab). Must be unique within the workbook and 31 characters or fewer. If omitted, Excel assigns a default name (e.g. Sheet2). E.g. Q3 Results |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "microsoft_excel",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "microsoft_excel-create-worksheet",
  arguments: {
    folderId: "Folder ID",
    sheetId: "Workbook",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "microsoft_excel-create-worksheet",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    microsoft_excel: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Folder ID",
    sheetId: "Workbook",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "microsoft_excel-create-worksheet",
    "configured_props": {
      "microsoft_excel": { "authProvisionId": "apn_xxxxxxx" },
      "folderId": "Folder ID",
      "sheetId": "Workbook"
    }
  }'
```

---

- App: https://pipedream.com/apps/microsoft-excel.md · All apps: https://pipedream.com/apps