---
title: "Create a personal link"
method: POST
path: "/personal_links"
tags: ["Personal links"]
---

# Create a personal link

`POST /personal_links`

## Request

- Base URL: `https://api.meetdarwin.ai/v1`
- URL: `https://api.meetdarwin.ai/v1/personal_links`
- Auth: HTTP bearer

Requires the `agent:write` scope.

Name a greeting (gr_…) or write a new_greeting in the same call. Darwin makes the link's id.

## Headers

- `Idempotency-Key` string

## Request body

- PersonalLinkInput
  - `name` string: What your team calls the campaign, e.g. "Q4 outbound".
  - `page` string: The page it opens: a path on your website (/pricing) or a full https address. The chat must be installed there.
  - `greeting` string, nullable: The greeting it shows (gr_…). Null makes it a draft, which greets no one.
  - `new_greeting` LinkGreetingInput
    - `name` string: What your team calls it.
    - `text` string: What the chat says. Put a person's details in braces with words for when the link has none: {first|there}, {company|your team}, {title}, {last}. A field with no fallback is left out with the space before it.
    - `buttons` object[]: Up to four reply buttons. They replace the page's own; an empty list keeps the page's.
      - `label` string, required: What the reply button says. Fields allowed, e.g. "Pricing for {company|your team}".
      - `message` string: What a click sends as the visitor; the label when left out.
    - `agent_note` string, nullable: What the agent should know about people you send this to, e.g. why you reached out. Fields allowed. Null or empty removes it.

## Response `201`

OK

- PersonalLink
  - `id` string, required
  - `object` 'personal_link', required
  - `name` string, required
  - `page` string, required: The page it opens: a path on the workspace's website, or a full address.
  - `greeting` string, nullable, required: The greeting it shows (gr_…); null for a draft.
  - `status` 'active' | 'draft', required: draft: no greeting yet, so it greets no one.
  - `url` string, nullable, required: The page with the link's id. Add a person's details as dw_email, dw_first, dw_last, dw_company and dw_title, or ask POST /personal_links/{id}/urls to do it. Null for a draft.
  - `fields` string[], required: The details its greeting uses: first_name, last_name, company, title.
  - `templates` object, nullable, required: The address with each email tool's merge fields (hubspot, instantly, apollo, outreach, salesloft, lemlist, other), ready to paste into a sequence. Null for a draft.
  - `results` object, required: The last 30 days: people who opened it, how many of them chatted, and how many booked. Your team's and test visits are left out.
    - `days` integer, required
    - `visits` integer, required
    - `chats` integer, required
    - `meetings` integer, required

## Other responses

- `400`: Invalid request (`invalid_request`, `unsupported_version`).
- `401`: Missing or invalid key (`authentication_required`, `invalid_api_key`).
- `402`: The workspace must add a card before the API can be used (`payment_required`).
- `403`: The key lacks the scope (`insufficient_scope`).
- `404`: No such object in this workspace (`not_found`).
- `409`: Conflicts with the current state (`conflict`, `idempotency_key_in_use`).
- `422`: Refused by a rule (`unprocessable`, `idempotency_key_reused`).
- `429`: Rate limited (`rate_limited`) or a monthly allowance used (`quota_exceeded`); see Retry-After.

---

[API](https://skmtc.dev/meetdarwin/apis/darwin-api.md) · [All operations](https://skmtc.dev/meetdarwin/apis/darwin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/meetdarwin/apis/darwin-api/revisions/4b7ea8fe8645?raw)