Links

The most recent individual clicks on a link — when, from which country and city, on what device and browser, where they came from, and whether they were sent through or stopped by a rule.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.clicks \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_clicks at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use domains.connect, which writes the same rows and is the maintained version. Registers a domain the organization owns so links and pages can be served on it. Creates a Cloudflare custom hostname and starts certificate issuance; the domain will NOT serve anything until the owner adds a CNAME record at their DNS provider and the certificate is issued. Nothing is charged, but this claims the hostname on the platform's Cloudflare zone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.connect_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example"
  }'

Over MCP the same operation is the tool links_connect_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a link and return its public URL. Costs nothing and sends nothing — the link is live immediately but nobody sees it until it is shared. Leave the name blank for a short random one. Leave domain_id blank to host it on the platform's own short address; supply one of the organization's connected domains to brand it. Rotating, sticky and overflow links need `targets`; a file link needs a file URL. To turn one natural-language brief into both an opt-in link and an AI-designed editable page, use links.generate_optin_page instead.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "short",
    "destination": "example"
  }'

Over MCP the same operation is the tool links_create at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use pixels.create, which writes the same rows and is the maintained version. Adds a retargeting pixel that can be attached to links. Supply the provider's own ID (from Meta Events Manager, Google Ads, and so on) — the snippet is generated from it. Use provider 'custom' with `custom_html` for anything else, which injects THAT HTML VERBATIM INTO A PUBLIC PAGE every visitor passing through the link loads: it is arbitrary third-party JavaScript running on the organization's own branded domain, and there is no review step. `scripts.create` is confirmed for exactly this payload.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.create_pixel \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "provider": "facebook"
  }'

Over MCP the same operation is the tool links_create_pixel at https://app.chirply.io/api/mcp, same bearer token, same input.

Add someone this organization buys clicks from. Assign them to a link (with clicks_ordered and order_amount) to see how much of what was paid for actually arrived.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.create_vendor \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'

Over MCP the same operation is the tool links_create_vendor at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a link, along with every click and conversion recorded against it. Anyone who already has the link gets a not-found page from then on. This cannot be undone — pause the link instead if you only want to stop it temporarily.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use pixels.delete, which deletes the same rows and is the maintained version. Permanently deletes a retargeting pixel and removes it from every link it was attached to. Those links stop building that audience from the next click on. This cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.delete_pixel \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_delete_pixel at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a traffic seller. Links assigned to them keep working and keep their ordered-click figures, but are no longer grouped under anyone. This cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.delete_vendor \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_delete_vendor at https://app.chirply.io/api/mcp, same bearer token, same input.

Create or reopen the dedicated drag-and-drop page for an opt-in link. This uses one page/funnel slot when first created, sends no messages, and does not change what visitors see until the page is published. The visual page controls layout and content while LinkWizard continues to control captured details, verification, account senders, tags, automations, and the final destination.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.design_optin_page \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_design_optin_page at https://app.chirply.io/api/mcp, same bearer token, same input.

Copy a link with all of its rules and destinations under a fresh random name. The copy is created PAUSED on purpose — an exact duplicate that went live immediately would start splitting traffic with the original before anything had been changed. Retargeting pixels are not copied.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.duplicate \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_duplicate at https://app.chirply.io/api/mcp, same bearer token, same input.

Switch on full-loop conversion tracking and return the one script to install. Once on, every tracked link appends a small `cwc` parameter to the DESTINATION URL — the organization's live public links start carrying an extra query parameter to whatever site they point at, which some destinations reject or log. THERE IS NO CAPABILITY TO TURN THIS BACK OFF: once an account has a tracker it keeps it, so this is one-way from the machine surfaces. Safe to call repeatedly — it returns the existing token if there is one.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.enable_tracking \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_enable_tracking at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a working LinkWizard opt-in link and an AI-designed, fully editable Page Builder draft from one plain-language brief. The link itself is active immediately and its built-in fallback form works, but the AI design does NOT replace that fallback until a human publishes the builder page. This SPENDS MONEY — the generation is billed to the organization's own AI provider key — and it uses one page/funnel slot against the plan's limit. It sends no messages and applies no tags or automations until a real visitor submits the form.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.generate_optin_page \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "example",
    "destination": "example"
  }'

Over MCP the same operation is the tool links_generate_optin_page at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one link by id with all of its rules, its rotation destinations and the retargeting pixels attached to it, plus its public URL.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_get at https://app.chirply.io/api/mcp, same bearer token, same input.

Whether this account lets OTHER accounts read contact context for people it sent to them on a tracked link, and which accounts may do it. Relevant when this account's contacts click through to a landing page somebody else owns — an affiliate or partner arrangement. Off by default. Read-only.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.get_contact_sharing \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_get_contact_sharing at https://app.chirply.io/api/mcp, same bearer token, same input.

The organization's conversion-tracking state, every website it tracks with the script tag for each, and the custom event names already seen. There is ONE script (`/embed/t.js`) which does visitor tracking and conversions together — there is no separate conversion-only snippet any more — but each website carries its OWN key, because that key is what scopes the site's origin allow-list and keeps one site's visitors out of another's reports. So `sites` is a list and there is deliberately no one default snippet: handing out one site's key for a different site produces beacons the origin allow-list refuses. Returns nothing configured if tracking has never been switched on.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.get_tracking \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_get_tracking at https://app.chirply.io/api/mcp, same bearer token, same input.

List the organization's links, newest first, with their click, unique-visitor and conversion counts. Optionally filter by kind, status, domain or tag, and search the name, label and destination.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool links_list at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use pixels.list, which reads the same rows and is the maintained version. Lists the retargeting pixels set up for this organization, ready to attach to links.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.list_pixels \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_list_pixels at https://app.chirply.io/api/mcp, same bearer token, same input.

List the people this organization buys clicks from, for assigning to links and tracking delivery against what was ordered.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.list_vendors \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_list_vendors at https://app.chirply.io/api/mcp, same bearer token, same input.

Totals across every link in the organization: how many links, how many clicks and how many conversions.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.overview \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool links_overview at https://app.chirply.io/api/mcp, same bearer token, same input.

The people this link was sent to individually, and which of them opened it — highest engagement first. Only populated when per-person link tracking is on: each recipient of an email or text gets their own copy of the link, so a click can be attributed to a named contact rather than an anonymous visitor.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.recipients \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_recipients at https://app.chirply.io/api/mcp, same bearer token, same input.

Let other accounts read the CRM context — name, email, tags, deals, messages, and call transcripts — of a contact of yours who clicked one of your tracked links onto THEIR landing page. This discloses your own customers' personal data to another business: they can use it to personalize the page that contact lands on. It never works in reverse, only applies to contacts who actually clicked one of your links, and turning it off takes effect immediately for every future request. Leave `destination_org_ids` empty to allow any destination (the usual choice for a public affiliate program); list account ids to restrict it to a named few.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.set_contact_sharing \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

Over MCP the same operation is the tool links_set_contact_sharing at https://app.chirply.io/api/mcp, same bearer token, same input.

Choose which connected domain rewritten tracking links go out on, instead of Chirply's own short host. Affects links minted from now on; links already sent keep resolving on the domain they went out with. `match_sending_domain` additionally puts each link on whichever connected domain shares a registrable domain with the address the message is actually sent from (so mail from hello@acme.com gets links on go.acme.com), falling back to `domain_id` when there is no match or the sender is not known yet — a link domain that does not match the From address reads as a forwarding service to mailbox providers, which costs deliverability.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.set_link_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "match_sending_domain": true
  }'

Over MCP the same operation is the tool links_set_link_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Switch per-person link rewriting for the whole account. When ON, every link inside outgoing emails and texts is rewritten so each recipient gets their own URL — clicks then carry the contact's identity, and so do any conversions they produce. All recipients still share ONE link, so editing where it points changes every message already delivered. Unsubscribe links are never rewritten. Turning it OFF does not break links already sent; it only stops new ones being minted. Switching it on also enables conversion tracking, which adds a `cwc` parameter to destination URLs, and every click on a rewritten link stamps a signed `ct` parameter naming the recipient onto the destination — that is what lets a landing page running the Chirply tracking script recognise which contact just arrived.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.set_link_rewriting \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'

Over MCP the same operation is the tool links_set_link_rewriting at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use pixels.attach, which writes the same rows and is the maintained version. Sets exactly which retargeting pixels fire on a link, replacing whatever was attached before. This changes what a LIVE public link does: attaching any pixel forces the link to show its short branded waiting page — that page is the only moment a pixel can fire on a click passing through to somebody else's site — and it starts running that pixel's third-party JavaScript for every visitor.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.set_pixels \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "pixel_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ]
  }'

Over MCP the same operation is the tool links_set_pixels at https://app.chirply.io/api/mcp, same bearer token, same input.

Set a link live, paused or archived. A paused link stops resolving immediately — everyone who opens it, including people who already have it, gets a not-found page.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.set_status \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "status": "active"
  }'

Over MCP the same operation is the tool links_set_status at https://app.chirply.io/api/mcp, same bearer token, same input.

Click and conversion statistics for one link over a window of days: totals, unique visitors, blocked clicks, conversions and their value, a per-day series, and rankings by country, device, browser, operating system and referring site.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.stats \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_stats at https://app.chirply.io/api/mcp, same bearer token, same input.

Update any field on an existing link. Omitted fields are left alone. THREE OF THESE FIELDS REACH THE PUBLIC IMMEDIATELY. `slug` and `domain_id` change the link's public URL, so every copy already shared, printed, emailed or posted to an ad platform starts returning a not-found page. `status` is the same write `links.set_status` gates: 'paused' or 'archived' kills the link dead for everyone holding it. And supplying `targets` REPLACES the whole destination list, which resets the per-destination click counts that overflow caps rely on. None of that can be undone by editing the field back — traffic lost in the meantime is gone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_update at https://app.chirply.io/api/mcp, same bearer token, same input.

DEPRECATED — use domains.update, which writes the same rows and is the maintained version. Sets what a connected domain serves: which funnel or single page is attached, where the bare domain redirects when nothing is attached, where unknown addresses go, and whether links are allowed on it at all. This reconfigures a LIVE public hostname: setting links_enabled false immediately stops every link hosted there from resolving, for everyone already holding one, and repointing funnel_id changes what the world sees at that address.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/links.update_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool links_update_domain at https://app.chirply.io/api/mcp, same bearer token, same input.