# Create Role — Peerdom

> Create a new role within a specified circle. See the documentation

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

## Description

Create a new role within a specified circle. [See the documentation](https://api.peerdom.org/v1/docs)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `name` | `string` | Yes | The name of the role to be created |
| `mapId` | `string` | Yes | The ID of the map Options are loaded from the connected account. |
| `parentId` | `string` | Yes | The ID should be a valid group ID. Options are loaded from the connected account. |
| `electable` | `boolean` | No | Whether the role is electable or not |
| `external` | `boolean` | No | Set to true if node is outside of the organization |
| `color` | `string` | No | The choice of color for the node in hexadecimal string format, e.g. #f3a935 |
| `shape` | `string` | No | Specifies the shape of the node that determines the visual representation of the node within the interface |
| `customFields` | `object` | No | The custom fields for a group/role. You can add the properties from the predefined custom fields. See the documentation for further details. |
| `groupEmail` | `string` | No | Email for node (group/role) communication |

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

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: "peerdom-create-role",
  arguments: {
    name: "Name",
    mapId: "Map ID",
  },
})
```

**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: "peerdom-create-role",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    peerdom: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    mapId: "Map ID",
  },
})

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": "peerdom-create-role",
    "configured_props": {
      "peerdom": { "authProvisionId": "apn_xxxxxxx" },
      "name": "Name",
      "mapId": "Map ID"
    }
  }'
```

---

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