# Create an Invite — Envoy

> Create an Invite to a person to visit a location. See the docs.

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

## Description

Create an Invite to a person to visit a location. [See the docs](https://developers.envoy.com/hub/reference/createinvite).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `expectedArrivalAt` | `string` | Yes | A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. |
| `locationId` | `string` | Yes | Unique identifier of a location. Options are loaded from the connected account. |
| `name` | `string` | Yes | Visitor full name. |
| `email` | `string` | No | Visitor email address. |
| `hostEmployeeId` | `string` | No | Unique identifier of a host. Options are loaded from the connected account. |
| `expectedDepartureAt` | `string` | No | A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. |
| `notes` | `string` | No | Enter your private notes. |
| `sendEmailToInvitee` | `boolean` | No | Either it should or not send email to invitee |

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

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: "envoy-create-an-invite",
  arguments: {
    expectedArrivalAt: "Arrival date",
    locationId: "Location",
  },
})
```

**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: "envoy-create-an-invite",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    envoy: { authProvisionId: "apn_xxxxxxx" },
    expectedArrivalAt: "Arrival date",
    locationId: "Location",
  },
})

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": "envoy-create-an-invite",
    "configured_props": {
      "envoy": { "authProvisionId": "apn_xxxxxxx" },
      "expectedArrivalAt": "Arrival date",
      "locationId": "Location"
    }
  }'
```

---

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