# Create Route — Mailgun

> Create a new route. See the docs here

- Key: `mailgun-create-route`
- Type: Action (Write)
- Version: 0.0.4
- App: Mailgun (`mailgun`) — https://pipedream.com/apps/mailgun.md
- This page (HTML): https://pipedream.com/apps/mailgun/actions/create-route
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/mailgun/actions/create-route/create-route.mjs

## Description

Create a new route. [See the docs here](https://documentation.mailgun.com/en/latest/api-routes.html#actions)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `priority` | `integer` | Yes | Priority ranks low to high, and higher priority routes are handled first |
| `description` | `string` | Yes | Description |
| `match` | `string` | Yes | For more information, see the route filters API documentation |
| `matchExpression` | `string` | Yes | For the recipient filter, specify a regex expression like .*@gmail.com. For the header filter, specify a header name followed by a colon followed by a regex, like subject:.*support. For the catch_all filters, leave this blank. |
| `action` | `string` | Yes | The route action to execute when the route expression evaluates to True. Formore information, see the [route actions API documentation][https://documentation.mailgun.com/en/latest/api-routes.html#actions] |
| `action_expression` | `string` | Yes | For the forward action, specify a destination email address or URL. For the store action, (optionally) specify a webhook URL to notify. For the stop action, leave this blank. |
| `haltOnError` | `boolean` | Yes | Halt on error? |

## 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": "mailgun",
      },
    },
  },
)

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: "mailgun-create-route",
  arguments: {
    priority: 10,
    description: "Description",
  },
})
```

**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: "mailgun-create-route",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mailgun: { authProvisionId: "apn_xxxxxxx" },
    priority: 10,
    description: "Description",
  },
})

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": "mailgun-create-route",
    "configured_props": {
      "mailgun": { "authProvisionId": "apn_xxxxxxx" },
      "priority": 10,
      "description": "Description"
    }
  }'
```

---

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