# Create Personalised Short Link — Hyperise

> Creates a personalised short URL from provided inputs. See the documentation

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

## Description

Creates a personalised short URL from provided inputs. [See the documentation](https://support.hyperise.com/en/api/Personalised-Short-Links-API)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `imageTemplateHash` | `string` | Yes | The image hash of the template to use Options are loaded from the connected account. |
| `destinationUrl` | `string` | Yes | The URL to create a personalised short URL for |
| `pageTitle` | `string` | Yes | Title of the page |
| `pageDescription` | `string` | Yes | Description of the page |
| `firstName` | `string` | No | Personalisation Data - first name |
| `lastName` | `string` | No | Personalisation Data |
| `profileUrl` | `string` | No | Personalisation Data - Image URL of the prospects profile image |
| `jobTitle` | `string` | No | Personalisation Data - job title |
| `email` | `string` | No | Personalisation Data - email address |
| `phone` | `string` | No | Personalisation Data - phone number |

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

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: "hyperise-create-personalised-short-link",
  arguments: {
    imageTemplateHash: "Image Template Hash",
    destinationUrl: "Destination URL",
  },
})
```

**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: "hyperise-create-personalised-short-link",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hyperise: { authProvisionId: "apn_xxxxxxx" },
    imageTemplateHash: "Image Template Hash",
    destinationUrl: "Destination URL",
  },
})

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": "hyperise-create-personalised-short-link",
    "configured_props": {
      "hyperise": { "authProvisionId": "apn_xxxxxxx" },
      "imageTemplateHash": "Image Template Hash",
      "destinationUrl": "Destination URL"
    }
  }'
```

---

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