Personal links

Change a personal link

Requires the agent:write scope.

A new greeting reaches every email already sent, because the greeting is looked up by the link's id. A new page only applies to addresses made after the change.

patch/personal_links/{id}

Request

  • Base URL: https://api.meetdarwin.ai/v1
  • URL: https://api.meetdarwin.ai/v1/personal_links/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Retry safely: the first response is replayed for 24 hours (not for streamed answers).

Request body

namestring

What your team calls the campaign, e.g. "Q4 outbound".

pagestring

The page it opens: a path on your website (/pricing) or a full https address. The chat must be installed there.

greetingstring nullable

The greeting it shows (gr_…). Null makes it a draft, which greets no one.

Response

OK

idstring required
object'personal_link' required
namestring required
pagestring required

The page it opens: a path on the workspace's website, or a full address.

greetingstring nullable required

The greeting it shows (gr_…); null for a draft.

status'active' | 'draft' required

draft: no greeting yet, so it greets no one.

urlstring 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.

fieldsstring[] required

The details its greeting uses: first_name, last_name, company, title.

templatesobject 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.

Example response

{
  "id": "lk_q4x7mz",
  "url": "https://www.acme.example/pricing?dw=lk_q4x7mz"
}

Changes

No recorded changes to this operation across all 1 revision of this API.