Links API

Links endpoints exposed by the Devotel CPaaS API Base path: /api/v1/links Endpoint count: 14

Worked Links samples

A tracked short link moves through four calls below — mint it (POST /api/v1/links), watch the click stream land (POST to the redirect, GET /api/v1/links//stats), page the full list (GET /api/v1/links), then receive the per-click webhook (short_link.click with an HMAC signature). Substitute your key and tenant ids where shown. Successful requests below use the standard { data, meta } envelope; the redirect (GET /l/{code}) is the one public surface that bypasses the envelope entirely (it issues a 302 with Location headers, no JSON body).

1. Create a short link

POST /api/v1/links

Mint a tracked link by passing the destination url. Drop UTM parameters straight into the destination URL (the API never parses them out — it treats the query string as opaque) and pair with campaign_id when the link belongs to a campaign so clicks roll up to the per-campaign analytics surface. The write rate limit is 20 requests per minute per tenant.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/links" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/promo?utm_source=sms&utm_campaign=may26",
    "campaign_id": "cmp_may26"
  }'

Node.js

const res = await fetch('https://api.orbit.devotel.io/api/v1/links', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com/promo?utm_source=sms&utm_campaign=may26',
    campaign_id: 'cmp_may26',
  }),
});
const link = await res.json();
// link.data.short_url is the shareable string — persist it.

{
  "data": {
    "id": "link_01J6A4ZK8H2GQX7M9B3TNV",
    "code": "gH4kM2",
    "original_url": "https://example.com/promo?utm_source=sms&utm_campaign=may26",
    "tenant_id": "tenant_7f2a",
    "campaign_id": "cmp_may26",
    "message_id": null,
    "short_url": "https://api.orbit.devotel.io/l/gH4kM2",
    "created_at": "2026-09-10T09:14:22.417Z"
  },
  "meta": {
    "request_id": "req_01J6PZ3WT2Y1N0MDKX4H8RQB",
    "timestamp": "2026-09-10T09:14:22.512Z"
  }
}

Two things worth keeping off the response: data.code is the 6-character public code (uniform distribution, no ambiguous characters) and data.short_url is the shareable string — {short-domain}/l/{code}. On a tenant with a branded domain (organizations.settings.short_link_domain) the same mint comes back with your vanity host, e.g. https://go.yourbrand.com/l/gH4kM2. Only http:// and https:// URLs mint; any other protocol answers 422.

2. Redirect-click deep dive

GET /api/v1/links/{id}/stats

A click on https://api.orbit.devotel.io/l/gH4kM2 redirects (302) to the destination, records IP + user-agent + referrer, resolves the best-effort country the edge CDN stamps (e.g. Cloudflare’s cf-ipcountry), classifies the click’s traffic quality (bot / preview vs probable-human), then lands in this endpoint’s stats view. Read it back with GET on the link id.

cURL

curl "https://api.orbit.devotel.io/api/v1/links/link_01J6A4ZK8H2GQX7M9B3TNV/stats" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

const statsRes = await fetch(
  'https://api.orbit.devotel.io/api/v1/links/link_01J6A4ZK8H2GQX7M9B3TNV/stats',
  { headers: { 'X-API-Key': process.env.ORBIT_API_KEY! } },
);
const { data: stats } = await statsRes.json();
// data.recent_clicks is the newest-first 50-click window.
// data.clicks_by_day is a per-day rollup for the last 30 days.

{
  "data": {
    "id": "link_01J6A4ZK8H2GQX7M9B3TNV",
    "code": "gH4kM2",
    "original_url": "https://example.com/promo?utm_source=sms&utm_campaign=may26",
    "short_url": "https://api.orbit.devotel.io/l/gH4kM2",
    "campaign_id": "cmp_may26",
    "recent_clicks": [
      {
        "id": "clk_01J6B8XR5M",
        "ip_address": "203.0.113.44",
        "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_4)",
        "referrer": "https://messages.apple.com",
        "country": "US",
        "clicked_at": "2026-09-10T09:40:11.201Z",
        "is_bot": false
      }
    ],
    "clicks_by_day": [
      { "date": "2026-09-10", "count": 42 },
      { "date": "2026-09-09", "count": 121 }
    ]
  },
  "meta": {
    "request_id": "req_01J6Q68X2R0H5P",
    "timestamp": "2026-09-10T09:41:02.003Z"
  }
}

The recent_clicks array is the per-click forensics surface (recent-clicks capped at 50 rows; link_clicks rows past that cap drop off this view but still count in clicks_by_day). The is_bot verdict on each click comes from the same traffic-quality classification the per-campaign analytics view reuses, so a human-only CTR is (clicks where is_bot=false) / raw_clicks. Country resolution depends on the deployment’s edge — when the edge supplies no geo header, country reads null rather than a fabricated guess.

3. List links with pagination

GET /api/v1/links?cursor=

The tenant’s full short-link surface pages newest-first via a cursor. Pass cursor=<next_cursor> on the next call; the response carries meta.pagination.next_cursor until you reach the tail. Filter by campaign_id when you only want one campaign’s links.

cURL

curl "https://api.orbit.devotel.io/api/v1/links?limit=25&campaign_id=cmp_may26" \
  -H "X-API-Key: dv_live_sk_your_key_here"
# Follow meta.pagination.next_cursor for the next page.
curl "https://api.orbit.devotel.io/api/v1/links?limit=25&cursor=link_01J5XXXX" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Node.js

let cursor: string | undefined;
const all: unknown[] = [];
do {
  const url = new URL('https://api.orbit.devotel.io/api/v1/links');
  url.searchParams.set('limit', '25');
  url.searchParams.set('campaign_id', 'cmp_may26');
  if (cursor) url.searchParams.set('cursor', cursor);
  const res = await fetch(url, {
    headers: { 'X-API-Key': process.env.ORBIT_API_KEY! },
  });
  const page = await res.json();
  all.push(...page.data);
  cursor = page.meta.pagination.next_cursor;
} while (cursor);

{
  "data": [
    {
      "id": "link_01J6A4ZK8H2GQX7M9B3TNV",
      "code": "gH4kM2",
      "original_url": "https://example.com/promo?utm_source=sms&utm_campaign=may26",
      "short_url": "https://api.orbit.devotel.io/l/gH4kM2",
      "campaign_id": "cmp_may26",
      "created_at": "2026-09-10T09:14:22.417Z"
    }
  ],
  "meta": {
    "request_id": "req_01J6R2W0X3Q8",
    "timestamp": "2026-09-10T09:42:18.110Z",
    "pagination": {
      "limit": 25,
      "total": 47,
      "has_more": true,
      "next_cursor": "link_01J5XXXXXXXXXXXXXXXXXXX"
    }
  }
}

Counting is bounded: the list-count is capped (same bounded posture as the sibling messages / conversations / contacts list endpoints) so the total field saturates rather than scanning the tenant’s whole history. Use the cursor to page safely; never trust total as the exact count past the cap.

4. Signed webhook for click events

A click on a tracked short link fans out short_link.click to every webhook endpoint registered for the tenant. Verify the signature before reading the body — the header is X-Orbit-Signature (Stripe-style t=<unix_ts>,v1=<hex>; the legacy X-Devotel-Signature is still accepted as a fallback for old queued deliveries). The signed string is ${t}.${raw_body}; verification uses your endpoint secret. A complete per-language handler lives at Verify webhook signatures.

Node.js

import crypto from 'node:crypto';

function verifyOrbitSignature(rawBody: string, header: string, secret: string) {
  const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')));
  const expected = crypto
    .createHmac('sha256', secret)
    .update(`${parts.t}.${rawBody}`)
    .digest('hex');
  // Reject stale timestamps outside the replay window before comparing.
  if (Math.abs(Date.now() / 1000 - Number(parts.t)) > 300) return false;
  return crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}

// In your handler:
const ok = verifyOrbitSignature(
  rawBody,                             // exact bytes Orbit POSTed, pre-parse
  req.headers['x-orbit-signature'],
  process.env.ORBIT_WEBHOOK_SECRET!,
);
if (!ok) return res.status(401).end();
const event = JSON.parse(rawBody);
if (event.type === 'short_link.click') {
  const c = event.data;
  // c.link_id, c.code, c.click_id, c.message_id, c.campaign_id,
  // c.country, c.is_bot, c.quality_score, c.quality_reason
}

The short_link.click payload is the consumer-side sibling of email.clicked: link_id + code identify the mint, message_id + campaign_id carry the attribution chain, and the country / user_agent / referrer fields match what the stats endpoint above returns. is_bot + quality_score + quality_reason let you filter preview / bot clicks on receive, the same way the analytics view filters them at read time.

5. Where the short-links guide hands off to API samples

The short-links cookbook walks the whole chain with runnable end-to-end recipes (mint → send → measure → react, then landing pages); the samples above live here so this endpoint page answers “what comes back” without leaving the API reference. Reach for the cookbook when you want a full use case; reach for this page’s sections when you only need the wire shape of one endpoint.

Errors worth branching on

These five failures cover the short-link create (POST /api/v1/links), hammered by campaign sends that mint tracked URLs. Each block below is a full { error, meta } envelope as the API returns it, and the matrix at the bottom answers retry vs surface for the same five classes. For the platform-wide decision table these branches plug into, see the error handling guide.

401 — Unauthorized

  {
    "error": {
      "code": "UNAUTHORIZED",
      "message": "The API key is invalid, expired, or lacks the required scope.",
      "status": 401
    },
    "meta": {
      "request_id": "req_linksa1",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 401 on this page is the bearer key failing before the route ran — it never means the resource is wrong. Rotate the key or re-mint the scoped token; retrying the same request changes nothing.

403 — Forbidden

  {
    "error": {
      "code": "FORBIDDEN",
      "message": "The key is valid but does not have the scope this operation requires.",
      "status": 403
    },
    "meta": {
      "request_id": "req_linksa1f",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 403 means the key authenticated but the operation is gated by scope — check the key’s scopes on the developer page; a 403 is never a data-not-found shape.

422 — Schema

  {
    "error": {
      "code": "VALIDATION_ERROR",
      "message": "The request failed input validation.",
      "status": 422,
      "details": { "field": "destination_url", "value": "htp://example", "expected": "a valid https:// URL" }
    },
    "meta": {
      "request_id": "req_linksb2",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 422 means the payload did not match the request schema — branch on error.details.field and resend with an https:// destination_url instead of blind-retrying the same body.

429 — Rate

  {
    "error": {
      "code": "RATE_LIMITED",
      "message": "Too many requests in the current window.",
      "status": 429,
      "details": { "retry_after": 12 }
    },
    "meta": {
      "request_id": "req_linksc3",
      "timestamp": "2026-09-03T12:00:00Z",
      "docs_url": "https://docs.orbit.devotel.io/errors/RATE_LIMITED"
    }
  }

The Retry-After header and error.details.retry_after are both set on every 429 — resend the SAME request after the lower of the two.

404 — Not found

  {
    "error": {
      "code": "LINK_DOMAIN_NOT_VERIFIED",
      "message": "This short-link domain has not completed DNS verification.",
      "status": 404,
      "details": { "domain": "go.acme.example", "verification_status": "dns_pending" }
    },
    "meta": {
      "request_id": "req_linksd4",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

Surface the DNS record to re-check; do not recreate the link.

60-second retry matrix

Class	Meaning	Branch response
401 `UNAUTHORIZED`	the bearer key itself fails	Surface. Rotate the key or re-mint the scoped token; do not retry the same request.
403 `FORBIDDEN`	the key lacks this operation’s scope	Surface. Fix the key’s scope set; a retry with the same key never heals it.
422 `VALIDATION_ERROR`	the payload does not match the schema	Fix, then resend intentionally. Branch on `error.details.field`; a blind retry repeats the same 422.
429 `RATE_LIMITED`	the window quota is exhausted	Retry after `error.details.retry_after` (or the `Retry-After` header) with the same request body.
`LINK_DOMAIN_NOT_VERIFIED` (404 not found)	page-specific gating	Branch on `error.code`. Surface the DNS record to re-check; do not recreate the link.

List links

GET /api/v1/links

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
      "short_url": "https://dv.li/7kQ2m",
      "destination": "https://example.com/promo",
      "status": "active",
      "total_clicks": 4821,
      "created_at": "2026-08-26T09:11:34.000Z"
    }
  ],
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List stats

GET /api/v1/links/{id}/stats

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
    "total_clicks": 4821,
    "unique_clickers": 2190,
    "by_country": [
      "US",
      "GB",
      "DE"
    ],
    "last_clicked_at": "2026-08-26T11:40:12.000Z"
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get per-campaign link-click analytics

GET /api/v1/links/campaigns/{campaignId}/link-analytics

Per-campaign SMS link-tracking + click-attribution rollup: totals (minted links, raw clicks, verified human-only clicks, unique clicker recipients, attributed recipients, and the derived attribution rates), a per-channel breakdown, and a top-links ranking with each row’s resolved short URL. Out-of-range values clamp to the spec bounds; a campaign with no shortened links reports zeroed totals rather than NaN rates.

string

required

Campaign identifier the links were minted for.

integer

Trailing aggregation window in days (1–365, default 7).

integer

Max top-links rows (1–50, default 10).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/campaigns/{campaignId}/link-analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "campaign_id": "cmp_1a2b3c4d5e6f7081a2b3c4d5",
    "window_days": 7,
    "totals": {
      "links_minted": 84,
      "raw_clicks": 4821,
      "human_clicks": 2190,
      "unique_clickers": 1044,
      "attributed_recipients": 612,
      "attribution_rate_pct": 58.6
    },
    "by_channel": [
      {
        "channel": "sms",
        "clicks": 2190
      }
    ],
    "top_links": [
      {
        "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
        "short_url": "https://dv.li/7kQ2m",
        "clicks": 1132
      }
    ]
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

List clicks

GET /api/v1/links/contacts/{contactId}/clicks

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/contacts/{contactId}/clicks');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact_id": "contact_4d2f6a8c1e3b5d7f9a1c3e5b",
    "clicks": [
      {
        "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
        "clicked_at": "2026-08-26T10:04:11.000Z"
      }
    ]
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List insights

GET /api/v1/links/insights

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/insights" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/insights', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/insights", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/insights", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/insights')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/insights');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "window": "last_30d",
    "top_links": [
      {
        "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
        "clicks": 4821
      },
      {
        "link_id": "lnk_9d1f3a5b7c9e1a3c5e7f8a9c",
        "clicks": 3102
      }
    ],
    "avg_ctr_pct": 4.7
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List landing pages

GET /api/v1/links/landing-pages

List the tenant’s landing pages with cursor-based pagination and an optional lifecycle-status filter.

string (enum: draft|published|archived)

Filter by lifecycle status.

string

Opaque cursor for the next page (from previous response meta.pagination.cursor).

integer

Number of items per page (default 25; silently capped at 200).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/landing-pages" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/landing-pages", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/landing-pages", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "slug": "string",
      "title": "string",
      "status": "draft",
      "short_link_id": null,
      "short_code": null,
      "campaign_id": null,
      "short_url": null,
      "render_url": null,
      "published_at": null,
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "pagination": {
      "cursor": "string",
      "has_more": false,
      "total": 0
    }
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Get a landing page

GET /api/v1/links/landing-pages/{id}

Fetch a single landing page by id.

string

required

Landing page identifier.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "slug": "string",
    "title": "string",
    "status": "draft",
    "short_link_id": null,
    "short_code": null,
    "campaign_id": null,
    "short_url": null,
    "render_url": null,
    "published_at": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Get landing page analytics

GET /api/v1/links/landing-pages/{id}/analytics

Per-page visits + conversions rolled up by campaign and by originating message, plus the most recent conversions.

string

required

Landing page identifier.

integer

Max rows per breakdown (by campaign / by message), 1–50, default 10.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "landing_page_id": "lpg_8b1c3d5e7f9a1b3c5d7e9f0a",
    "visits": 4821,
    "conversions": 612,
    "by_campaign": [
      {
        "campaign_id": "cmp_1a2b3c4d5e6f7081a2b3c4d5",
        "visits": 2310,
        "conversions": 289
      }
    ],
    "recent": [
      {
        "conversion_id": "cvn_6f1a3b5c7d9e1f3a5b7c9d1e",
        "occurred_at": "2026-08-26T10:04:11.000Z"
      }
    ]
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Create links

POST /api/v1/links

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/links" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/links", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/links", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "link_id": "lnk_2c4e6a8b0d2f4a6b8c0e2a4c",
    "short_url": "https://dv.li/7kQ2m",
    "destination": "https://example.com/promo",
    "status": "active",
    "created_at": "2026-08-26T12:00:00.000Z"
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create a landing page

POST /api/v1/links/landing-pages

Create a draft no-code landing page. content is the builder block list, re-validated in depth by the service. The page starts in draft and only mints a trackable short URL once published.

string

string (enum: true|false)

string

required

Human-readable page title.

string

Optional URL slug. Auto-derived from the title when omitted; unique per tenant.

any

Builder block list (page structure). Validated in depth by the service.

string

Optional campaign to attribute visits/conversions to.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/links/landing-pages" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "title": "string"
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/links/landing-pages", headers=headers, json={
  "title": "string"
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/links/landing-pages", bytes.NewBuffer([]byte(`{
  "title": "string"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "title": "string"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "title": "string"
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "slug": "string",
    "title": "string",
    "status": "draft",
    "short_link_id": null,
    "short_code": null,
    "campaign_id": null,
    "short_url": null,
    "render_url": null,
    "published_at": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Publish a landing page

POST /api/v1/links/landing-pages/{id}/publish

Publish a landing page and mint its trackable short URL. Transitions status to published and returns the page with short_url populated.

string

required

Landing page identifier.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/publish');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "slug": "string",
    "title": "string",
    "status": "draft",
    "short_link_id": null,
    "short_code": null,
    "campaign_id": null,
    "short_url": null,
    "render_url": null,
    "published_at": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Update a landing page

PATCH /api/v1/links/landing-pages/{id}

Patch a landing page’s title, builder content, campaign attribution, or archive it. Every field is optional; content is re-validated in depth when present.

string

required

Landing page identifier.

string (enum: true|false)

string

Human-readable page title.

any

Builder block list (page structure). Validated in depth by the service.

string | null

Campaign to attribute visits/conversions to. Pass null to clear.

string (enum: draft|archived)

Move the page between draft and archived.

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.patch("https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Patch.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "slug": "string",
    "title": "string",
    "status": "draft",
    "short_link_id": null,
    "short_code": null,
    "campaign_id": null,
    "short_url": null,
    "render_url": null,
    "published_at": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Delete links

DELETE /api/v1/links/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Delete a landing page

DELETE /api/v1/links/landing-pages/{id}

Delete a landing page; its visit/conversion events cascade. Returns 204 on success.

string

required

Landing page identifier.

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.delete("https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Delete.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/links/landing-pages/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

Response: 204 No Content

API Reference

All Endpoints

Links API

Links API

Worked Links samples

1. Create a short link

2. Redirect-click deep dive

4. Signed webhook for click events

5. Where the short-links guide hands off to API samples

Errors worth branching on

401 — Unauthorized

403 — Forbidden

422 — Schema

429 — Rate

404 — Not found

60-second retry matrix

List links

List stats

Get per-campaign link-click analytics

List clicks

List insights

List landing pages

Get a landing page

Get landing page analytics

Create links

Create a landing page

Publish a landing page

Update a landing page

Delete links

Delete a landing page

​Links API

​Worked Links samples

​1. Create a short link

​2. Redirect-click deep dive

​3. List links with pagination

​4. Signed webhook for click events

​5. Where the short-links guide hands off to API samples

​Errors worth branching on

​401 — Unauthorized

​403 — Forbidden

​422 — Schema

​429 — Rate

​404 — Not found

​60-second retry matrix

​List links

​List stats

​Get per-campaign link-click analytics

​List clicks

​List insights

​List landing pages

​Get a landing page

​Get landing page analytics

​Create links

​Create a landing page

​Publish a landing page

​Update a landing page

​Delete links

​Delete a landing page

Links API

Worked Links samples

1. Create a short link

2. Redirect-click deep dive

3. List links with pagination

4. Signed webhook for click events

5. Where the short-links guide hands off to API samples

Errors worth branching on

401 — Unauthorized

403 — Forbidden

422 — Schema

429 — Rate

404 — Not found

60-second retry matrix

List links

List stats

Get per-campaign link-click analytics

List clicks

List insights

List landing pages

Get a landing page

Get landing page analytics

Create links

Create a landing page

Publish a landing page

Update a landing page

Delete links

Delete a landing page