Developers

Build on Linkdeck with the REST API, or let an AI assistant manage your page through the MCP server.

Quick start

  • Create an API key under Account, then API keys in the dashboard. It starts with ld_ and is shown once.
  • Send it with every request: Authorization: Bearer ld_your_key.
  • Start with GET /profiles to find your profile IDs.
curl "https://linkdeck.link/api/v1/profiles" -H "Authorization: Bearer $KEY"

Errors come back as JSON with a plain-language message, such as { "error": "Invalid API key." }. A 402 means editing is locked on the account (the trial ended, or the profile is over its plan's limit); reading still works. A 429 means wait a minute.

The full spec is at /api/v1/openapi.json (OpenAPI 3.1). Import it into Postman, Insomnia or a code generator, or give it to a custom GPT as an action.

AI assistants (MCP)

The MCP server at https://linkdeck.link/mcp lets Claude, ChatGPT and other assistants read your stats and edit your page when you ask them to in a chat. Step-by-step setup for each app is in API and webhooks.

Sign in with Linkdeck (the default)

Add https://linkdeck.link/mcp as a connector in ChatGPT, Claude or any MCP client that supports sign-in. You sign in to Linkdeck, then choose which profiles the assistant can see and whether it can only read or also make changes. There's no key to copy, and you can disconnect it any time under Account, Connected apps. Team members can connect an assistant to a workspace they belong to; it never gets more than their role allows, and the workspace owner sees it in their Connected apps.

For client developers: this is standard MCP authorization (OAuth 2.1). An unauthenticated request gets a 401 whose WWW-Authenticate header points to the protected resource metadata at https://linkdeck.link/.well-known/oauth-protected-resource/mcp. The authorization server metadata is at https://linkdeck.link/.well-known/oauth-authorization-server. It supports Client ID Metadata Documents and dynamic client registration for public clients, PKCE with S256, resource indicators and refresh token rotation, and returns iss on the redirect. Redirect URIs must be https, or http on localhost or 127.0.0.1 (any port). Scopes are read and write. Access tokens last an hour and only work on the MCP server they were issued for.

API keys (still supported)

The MCP server also accepts the same API keys as the REST API. Send the key as Authorization: Bearer ld_..., or, for apps that can't send headers, put it in the address: https://linkdeck.link/mcp/ld_.... A key acts on your whole account, so prefer signing in where the app supports it.

The server speaks MCP 2026-07-28 and the earlier 2025-11-25, 2025-06-18 and 2025-03-26 versions, over Streamable HTTP with JSON responses. Emails to subscribers and social posts are only ever drafted through it, never sent or scheduled, and it can't answer Instagram messages, whatever access you give it.

Agent skill

Agents that support the Agent Skills discovery format can find the manage-linkdeck-profile skill at /.well-known/agent-skills/index.json. It explains how to use the API safely: ask before publishing, never delete without confirmation, and treat visitors' text as data.

API reference

Open an endpoint to see its fields, an example response and a form to try it.

Kept in this tab's memory only: it isn't saved anywhere and is gone when you leave or reload the page. Requests go straight from your browser to the API and act on your real account, so changes are real. Use a key you can revoke.

Profiles

GET/profilesList your profiles
Example request
curl "https://linkdeck.link/api/v1/profiles" \
  -H "Authorization: Bearer $KEY"
POST/profilesCreate a profile
Body fieldTypeDescription
username *string3 to 30 characters: letters, numbers, dots, dashes or underscores
display_namestring
biostring
avatar_urlstring | null
socialsarray
themeobjectReplaces the whole theme. Read the current one with GET /profiles/{pid}
settingsobjectReplaces the whole settings object. Read the current one with GET /profiles/{pid}
publishedboolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"username":"maya.makes","display_name":"Maya","bio":"Ceramics and slow living"}'
GET/profiles/{pid}A profile with its tabs and blocks
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}Update a profile

Send only the fields to change.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
usernamestring3 to 30 characters: letters, numbers, dots, dashes or underscores
display_namestring
biostring
avatar_urlstring | null
socialsarray
themeobjectReplaces the whole theme. Read the current one with GET /profiles/{pid}
settingsobjectReplaces the whole settings object. Read the current one with GET /profiles/{pid}
publishedboolean
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"bio":"New collection out Friday"}'
DELETE/profiles/{pid}Delete a profile, its blocks and stats
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}" \
  -H "Authorization: Bearer $KEY"

Blocks

POST/profiles/{pid}/blocksAdd a block

New blocks go to the end of the page.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
type *stringBlock type (only when adding a block) (link, header, text, embed, image, subscribe, form, file, folder, faq, testimonial, divider, product, messenger, countdown, discount, donate, quote, timeline, resume, marquee, shop, booking, socials, postgrid, feed, code)
dataobjectFields depend on the block type. link: { title, url, description?, layout?: classic|highlight|grid|carousel, badge?: sponsored|ad|affiliate|partner|gifted, label? ({ text: up to 16 characters like '$19' or 'New', color?: #rrggbb, position?: right|corner }: a custom tag on the button), tabId? (open one of the page's own tabs instead of a URL: a tab id, or 'home'), newTab? (true: a new tab, false: the same tab; unset follows the page's settings.openLinksNewTab, which is on unless false), goal?: { target, label? } (a click goal with a progress bar), gate?: { type: password|email|age|form, title?, message?, button?, password? (password gates), askName? (email), minAge? (age: 13|16|18|19|21), fields? (form) } }. header: { text, size?: small|medium|large, align?: left|center|right }. text: { html, style?: plain|card|sticky|bubble|torn|chalk, paper? (sticky, bubble, torn: yellow|pink|blue|green|white|kraft; chalk: green|black|slate) }. embed: { url (YouTube, Spotify, TikTok and so on), title? }. image: { url, alt?, link?, fullBleed?, noZoom? }. subscribe: { title?, description?, buttonText?, collectName?, askConsent?, consentText?, collect? (email|phone|both, default email), smsConsentText? ({name} is the page's name) }. form: { title?, fields: [{ label, type: text|email|phone|textarea|select|checkbox|number|date|url|time|radio|checkboxes|rating|country|heading|address, required?, options? }], submitText?, successMessage?, notifyEmail?, addToList? (needs an email field) }. file: { title, fileKey, filename } (upload in the dashboard first). folder: { title, open?, inline? (show its blocks in place instead of a pop-up) }; folders can go 3 levels deep (set parent_id on the block). faq: { title?, items: [{ q, a }] }. testimonial: { quote, author?, role?, avatar?, rating? (0-5), link?, more?: [up to 11 more { quote, author?, role?, avatar?, rating?, link? }] }. divider: { label?, line?: solid|dashed|dotted|none, thickness? (1-8), color? (#rrggbb), space?: small|medium|large }. product: { productId, layout?: card|button }. messenger: { title?, message?, layout?: buttons|icons, items: [{ app: whatsapp|telegram|messenger|signal|viber|line|sms|call|email, value (number or username), label? }] }. countdown: { title?, endsAt (ISO date-time), endedText?, link?, linkText?, hideWhenDone?, revealBlockId? (a hidden block shown when it ends) }. discount: { title?, code, description?, url?, expiresAt?, brand?, logo?, badge?, more?: [up to 9 { title?, code, badge?, description?, url? }], gate? (as on links) }; copies are counted (GET /analytics/copies). donate: { title?, description?, provider: paypal|venmo|cashapp, handle, amounts? (up to 5), currency? (3 letters) }. quote: { text, author?, source?, heading? }. timeline: { title?, items: [{ date, title, text?, eyebrow?, badge? }], markers?: numbers, highlight? (item index) }. resume: { title?, summary?, sections: [{ heading, items: [{ title, org?, dates?, text?, current?, link? }] }], skills? }. marquee: { text, speed?: slow|normal|fast, link?, separator?, direction?: right, ribbon? }. shop: { title?, shopDomain (your-store.myshopify.com), token (Storefront API token), collection?, count? (1-12), layout?: grid|carousel }. booking: { url (a Calendly or Cal.com booking page), title?, theme?: dark|custom, bg?, text?, primary? (custom colours), hideDetails? }. socials: { title?, source?: profile|custom (profile = the profile's social icons), items? ([{ platform, url }] for custom), size?: small|medium|large }. postgrid: { title?, planner? (false hides planner posts), instagram? (false hides synced Instagram posts), tiles?: [{ image, url, title? }], pinFirst?, max?: 6|9|12|18 }. feed: { kind: youtube|blog|podcast|etsy, source (channel or @handle URL, site or feed URL, Apple Podcasts URL, or Etsy shop), title?, count?, layout?: list|grid|carousel, thumbnails?, dates?, player?, appleUrl?, spotifyUrl? }; items are fetched on save and refreshed twice a day. code: { title?, html?, css?, js? (50 KB together, run in a sandboxed frame), height? (px), autoHeight? }. Any type: popup? ({ trigger: delay|scroll|exit, delay? (seconds), scroll? (percent), frequency: once|session|always, tabs? (tab ids, 'home' for the first), title? }) shows the block as a pop-up instead of in the page. On update, data replaces the block's whole data object.
styleobject{ bg?, color?, borderColor?: '#rrggbb', borderWidth?, radius?, shadow?: none|soft|hard, font?, animation? }
scheduleobjectWhen the block shows
enabledbooleanHidden when false
tab_idstring | nullTab to put the block in; null for the main tab
parent_idstring | nullFolder block to put it in; null for the top level
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/blocks" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"link","data":{"title":"My new video","url":"https://youtube.com/watch?v=abc123"}}'
PATCH/profiles/{pid}/blocks/{bid}Update a block
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
bid *pathBlock ID
Body fieldTypeDescription
dataobjectFields depend on the block type. link: { title, url, description?, layout?: classic|highlight|grid|carousel, badge?: sponsored|ad|affiliate|partner|gifted, label? ({ text: up to 16 characters like '$19' or 'New', color?: #rrggbb, position?: right|corner }: a custom tag on the button), tabId? (open one of the page's own tabs instead of a URL: a tab id, or 'home'), newTab? (true: a new tab, false: the same tab; unset follows the page's settings.openLinksNewTab, which is on unless false), goal?: { target, label? } (a click goal with a progress bar), gate?: { type: password|email|age|form, title?, message?, button?, password? (password gates), askName? (email), minAge? (age: 13|16|18|19|21), fields? (form) } }. header: { text, size?: small|medium|large, align?: left|center|right }. text: { html, style?: plain|card|sticky|bubble|torn|chalk, paper? (sticky, bubble, torn: yellow|pink|blue|green|white|kraft; chalk: green|black|slate) }. embed: { url (YouTube, Spotify, TikTok and so on), title? }. image: { url, alt?, link?, fullBleed?, noZoom? }. subscribe: { title?, description?, buttonText?, collectName?, askConsent?, consentText?, collect? (email|phone|both, default email), smsConsentText? ({name} is the page's name) }. form: { title?, fields: [{ label, type: text|email|phone|textarea|select|checkbox|number|date|url|time|radio|checkboxes|rating|country|heading|address, required?, options? }], submitText?, successMessage?, notifyEmail?, addToList? (needs an email field) }. file: { title, fileKey, filename } (upload in the dashboard first). folder: { title, open?, inline? (show its blocks in place instead of a pop-up) }; folders can go 3 levels deep (set parent_id on the block). faq: { title?, items: [{ q, a }] }. testimonial: { quote, author?, role?, avatar?, rating? (0-5), link?, more?: [up to 11 more { quote, author?, role?, avatar?, rating?, link? }] }. divider: { label?, line?: solid|dashed|dotted|none, thickness? (1-8), color? (#rrggbb), space?: small|medium|large }. product: { productId, layout?: card|button }. messenger: { title?, message?, layout?: buttons|icons, items: [{ app: whatsapp|telegram|messenger|signal|viber|line|sms|call|email, value (number or username), label? }] }. countdown: { title?, endsAt (ISO date-time), endedText?, link?, linkText?, hideWhenDone?, revealBlockId? (a hidden block shown when it ends) }. discount: { title?, code, description?, url?, expiresAt?, brand?, logo?, badge?, more?: [up to 9 { title?, code, badge?, description?, url? }], gate? (as on links) }; copies are counted (GET /analytics/copies). donate: { title?, description?, provider: paypal|venmo|cashapp, handle, amounts? (up to 5), currency? (3 letters) }. quote: { text, author?, source?, heading? }. timeline: { title?, items: [{ date, title, text?, eyebrow?, badge? }], markers?: numbers, highlight? (item index) }. resume: { title?, summary?, sections: [{ heading, items: [{ title, org?, dates?, text?, current?, link? }] }], skills? }. marquee: { text, speed?: slow|normal|fast, link?, separator?, direction?: right, ribbon? }. shop: { title?, shopDomain (your-store.myshopify.com), token (Storefront API token), collection?, count? (1-12), layout?: grid|carousel }. booking: { url (a Calendly or Cal.com booking page), title?, theme?: dark|custom, bg?, text?, primary? (custom colours), hideDetails? }. socials: { title?, source?: profile|custom (profile = the profile's social icons), items? ([{ platform, url }] for custom), size?: small|medium|large }. postgrid: { title?, planner? (false hides planner posts), instagram? (false hides synced Instagram posts), tiles?: [{ image, url, title? }], pinFirst?, max?: 6|9|12|18 }. feed: { kind: youtube|blog|podcast|etsy, source (channel or @handle URL, site or feed URL, Apple Podcasts URL, or Etsy shop), title?, count?, layout?: list|grid|carousel, thumbnails?, dates?, player?, appleUrl?, spotifyUrl? }; items are fetched on save and refreshed twice a day. code: { title?, html?, css?, js? (50 KB together, run in a sandboxed frame), height? (px), autoHeight? }. Any type: popup? ({ trigger: delay|scroll|exit, delay? (seconds), scroll? (percent), frequency: once|session|always, tabs? (tab ids, 'home' for the first), title? }) shows the block as a pop-up instead of in the page. On update, data replaces the block's whole data object.
styleobject{ bg?, color?, borderColor?: '#rrggbb', borderWidth?, radius?, shadow?: none|soft|hard, font?, animation? }
scheduleobjectWhen the block shows
enabledbooleanHidden when false
tab_idstring | nullTab to put the block in; null for the main tab
parent_idstring | nullFolder block to put it in; null for the top level
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/blocks/{bid}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'
DELETE/profiles/{pid}/blocks/{bid}Delete a block

Deleting a folder moves its blocks to the top level.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
bid *pathBlock ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/blocks/{bid}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/blocks/reorderReorder blocks

Send every block in display order. Including tab_id or parent_id also moves the block.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
items *array
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/blocks/reorder" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"items":[{"id":"BLOCK_ID_2"},{"id":"BLOCK_ID_1"}]}'
POST/profiles/{pid}/link-previewWhich block a pasted address makes, with the page's title, description and image
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
url *string
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/link-preview" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://youtube.com/watch?v=abc123"}'

Tabs

POST/profiles/{pid}/tabsAdd a tab
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
title *string
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/tabs" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Shop"}'
PATCH/profiles/{pid}/tabs/{tid}Rename a tab, change its link, or lock it
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
tid *pathTab ID
Body fieldTypeDescription
titlestring
slugstring
gateobject | nullA lock on the whole tab (same shape as a link's gate); null removes it
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/tabs/{tid}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Members","gate":{"type":"email","title":"Join to see this tab"}}'
DELETE/profiles/{pid}/tabs/{tid}Delete a tab

Its blocks move to the end of the main tab.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
tid *pathTab ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/tabs/{tid}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/tabs/reorderReorder tabs
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
ids *array
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/tabs/reorder" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

Insights

GET/profiles/{pid}/analyticsViews, visitors, clicks, sources, places and devices

Bots are left out. Every filter narrows every number.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
fromqueryStart, in Unix milliseconds, or `all`. Default: 30 days before `to`
toqueryEnd, in Unix milliseconds. Default: now
countryqueryOnly this country. `~` = not recorded (Direct, Unknown)
cityqueryOnly this city. `City|CC` keeps cities in different countries apart. `~` = not recorded
devicequeryOnly this device. `~` = not recorded (Direct, Unknown)
browserqueryOnly this browser. `~` = not recorded (Direct, Unknown)
referrerqueryOnly this referrer. `~` = not recorded (Direct, Unknown)
sourcequeryOnly this source. `~` = not recorded (Direct, Unknown)
mediumqueryOnly this medium. `~` = not recorded (Direct, Unknown)
campaignqueryOnly this campaign. `~` = not recorded (Direct, Unknown)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/analytics" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/analytics/copiesDiscount code copies per block in the last 30 days
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/analytics/copies" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/analytics/liveVisits in the last 30 minutes
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
countryqueryOnly this country. `~` = not recorded (Direct, Unknown)
cityqueryOnly this city. `City|CC` keeps cities in different countries apart. `~` = not recorded
devicequeryOnly this device. `~` = not recorded (Direct, Unknown)
browserqueryOnly this browser. `~` = not recorded (Direct, Unknown)
referrerqueryOnly this referrer. `~` = not recorded (Direct, Unknown)
sourcequeryOnly this source. `~` = not recorded (Direct, Unknown)
mediumqueryOnly this medium. `~` = not recorded (Direct, Unknown)
campaignqueryOnly this campaign. `~` = not recorded (Direct, Unknown)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/analytics/live" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/analytics/exportEvery counted event in the period, as CSV
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
fromqueryStart, in Unix milliseconds, or `all`. Default: 30 days before `to`
toqueryEnd, in Unix milliseconds. Default: now
countryqueryOnly this country. `~` = not recorded (Direct, Unknown)
cityqueryOnly this city. `City|CC` keeps cities in different countries apart. `~` = not recorded
devicequeryOnly this device. `~` = not recorded (Direct, Unknown)
browserqueryOnly this browser. `~` = not recorded (Direct, Unknown)
referrerqueryOnly this referrer. `~` = not recorded (Direct, Unknown)
sourcequeryOnly this source. `~` = not recorded (Direct, Unknown)
mediumqueryOnly this medium. `~` = not recorded (Direct, Unknown)
campaignqueryOnly this campaign. `~` = not recorded (Direct, Unknown)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/analytics/export" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/subscribersMailing list, newest first (up to 5,000; CSV has everyone)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
formatquery`csv` for a CSV file instead of JSON (csv)
channelqueryemail: only people with an email. phone: only people with a phone number (email, phone)
tagqueryOnly people with this tag
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/subscribers" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/subscribers/tagsTags on the mailing list, with how many people have each
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/tags" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/subscribers/tagsAdd or remove tags on many subscribers
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
ids *arraySubscriber IDs, up to 5,000
addarray
removearray
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/tags" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["abc123"],"add":["VIP"]}'
DELETE/profiles/{pid}/subscribers/tags/{tag}Take a tag off everyone
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
tag *pathTag name
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/tags/{tag}" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/subscribers/{id}/tagsReplace one subscriber's tags
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathSubscriber ID
Body fieldTypeDescription
tags *array
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/{id}/tags" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"]}'
POST/profiles/{pid}/subscribers/importAdd up to 10,000 people to the mailing list

Deduped by email, then phone. Existing people only get a missing phone, name or email, and the tags. Imported people are marked source import and don't start welcome flows. permission must be true: you confirm you have permission to email them.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
rows *array
permission *booleanYou have permission to email these people
tagsarray
phone_countrystring | nullISO code for numbers without a country code
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/import" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"email":"maya@example.com","name":"Maya Lopez","tags":["Workshop"]}],"permission":true}'
DELETE/profiles/{pid}/subscribers/{id}Remove a subscriber
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathSubscriber ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/subscribers/{id}" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/submissionsForm replies, newest first (up to 5,000; CSV has everyone)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
blockqueryOnly this form block
formatquery`csv` for a CSV file instead of JSON (csv)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/submissions" \
  -H "Authorization: Bearer $KEY"
DELETE/profiles/{pid}/submissions/{id}Delete a form reply
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathForm submission ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/submissions/{id}" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/summaryLast full week in plain English, with the numbers
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/summary" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/link-healthThe last check of each link
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/link-health" \
  -H "Authorization: Bearer $KEY"

Versions

GET/profiles/{pid}/versionsSaved versions and scheduled launches
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/versions" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/versionsSave the current page as a version
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
labelstring
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/versions" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"Before the redesign"}'
POST/profiles/{pid}/versions/{vid}/restorePut a version live

The current page is saved as a version first.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
vid *pathVersion ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/versions/{vid}/restore" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/versions/{vid}/scheduleSchedule a launch, or cancel it with null
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
vid *pathVersion ID
Body fieldTypeDescription
publishAt *string | nullISO date-time at least a minute from now
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/versions/{vid}/schedule" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"publishAt":"2026-12-01T09:00:00Z"}'
DELETE/profiles/{pid}/versions/{vid}Delete a version
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
vid *pathVersion ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/versions/{vid}" \
  -H "Authorization: Bearer $KEY"

Web pages

GET/profiles/{pid}/pagesWeb pages, with views in the last 30 days
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/pages" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/pagesAdd a draft web page
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
titlestring
templatestring (blank, about, services, portfolio, contact)
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/pages" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Work with me","template":"services"}'
POST/profiles/{pid}/pages/reorderSet the menu order
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
ids *array
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/pages/reorder" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
GET/profiles/{pid}/pages/{id}One web page
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathWeb page ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/pages/{id}" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/pages/{id}Update a web page
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathWeb page ID
Body fieldTypeDescription
titlestring
slugstringAddress: /{username}/p/{slug}
descriptionstring
sectionsarrayPage sections (hero, text, imageText, features, gallery, pricing, testimonials, faq, cta, video, contact)
publishedboolean
show_in_navboolean
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/pages/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"published":true}'
DELETE/profiles/{pid}/pages/{id}Delete a web page
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathWeb page ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/pages/{id}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/pages/{id}/duplicateCopy a web page as a draft
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathWeb page ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/pages/{id}/duplicate" \
  -H "Authorization: Bearer $KEY"

Products

GET/profiles/{pid}/storeSelling status: Stripe and PayPal connections and the platform fee
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/store" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/productsProducts, with views (30 days), sales and earnings
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/products" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/productsAdd a draft product

Set the rest with PATCH, then publish.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
titlestring
price_centsinteger0 for free. Paid products cost at least 50. Memberships: the price per month or year
typestringWhat kind of product. Can't change once someone has bought it (download, course, coaching, webinar, membership, physical, community)
detailsobject
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/products" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Preset pack","price_cents":1900,"type":"download"}'
GET/profiles/{pid}/products/{id}One product (with options, for physical products)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/products/{id}Update a product

Send only the fields to change. A live product must stay buyable, so publishing checks what its type needs.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Body fieldTypeDescription
typestringWhat kind of product. Can't change once someone has bought it (download, course, coaching, webinar, membership, physical, community)
titlestring
slugstringAddress: /{username}/buy/{slug}
subtitlestring
descriptionstringHTML (sanitized)
image_urlstring | null
price_centsinteger0 for free. Paid products cost at least 50. Memberships: the price per month or year
currencystring (usd, eur, gbp, cad, aud, nzd)
pay_what_you_wantbooleanprice_cents becomes the minimum
button_textstring
delivery_urlstring | nullLink buyers get after paying (downloads and memberships)
thank_youstring
add_to_listbooleanOffer buyers the mailing list
detailsobjectSettings for the product's type; only the fields for that type are kept. coaching: { duration_min, buffer_min?, timezone (IANA, e.g. Europe/London), availability: [{ day (0 = Sunday), start: 'HH:MM', end: 'HH:MM' }], days_ahead?, notice_hours?, location (meeting link or address) }. webinar: { starts_local: 'YYYY-MM-DDTHH:MM', timezone, join_url, seat_limit?, replay_url? }. membership: { interval: month|year }. physical: { shipping_countries: ['GB', 'US'], shipping_rates?: [{ label, amount_cents }] (up to 5; none = free shipping) }. download and course need no details.
questionsarrayUp to 5 questions buyers answer at checkout
bump_product_idstring | nullAnother product offered as a tick-box at checkout (a download, course or event with a fixed price)
bump_textstring
upsell_product_idstring | nullAnother product offered after checkout
upsell_textstring
plan_paymentsinteger0, or 2 to 6 monthly payments (downloads and courses)
stockinteger | nullPhysical products without options: how many are left; null = no limit
affiliate_percentintegerAffiliate program: 0 = off, else the commission (1-90%) approved affiliates earn per sale
resell_percentintegerLet buyers resell it: 0 = off, else the commission (1-90%) a buyer earns by sharing their own link from the purchase page
publishedbooleanLive on the page. Each type needs its content first (a file or link, a lesson, availability, a date and join link...), and Stripe for paid products
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"delivery_url":"https://example.com/download","published":true}'
DELETE/profiles/{pid}/products/{id}Delete a product nobody has bought
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/products/{id}/courseModules and lessons of a course or membership
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}/course" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/products/{id}/courseReplace a course's modules and lessons

Send the whole outline. Keep ids to update existing modules and lessons; anything left out is removed.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Body fieldTypeDescription
modules *array
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}/course" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"modules":[{"title":"Getting started","lessons":[{"title":"Welcome","body":"<p>Hi!</p>","drip_days":0}]}]}'
GET/profiles/{pid}/products/{id}/course/statsCourse stats: views to finished students, completions per lesson, and each student's progress

Students are orders that joined in the range and still have access. With format=csv, the students table.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
rangequery30d, 90d or all (the default) (30d, 90d, all)
formatquery`csv` for a CSV file instead of JSON (csv)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}/course/stats" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/products/{id}/variantsReplace a physical product's options (sizes, colours)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathProduct ID
Body fieldTypeDescription
variants *array
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/products/{id}/variants" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"variants":[{"name":"Small","stock":10},{"name":"Large","stock":4}]}'

Orders

GET/profiles/{pid}/ordersSales and free downloads, newest first (up to 500; CSV has up to 5,000)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
productqueryOnly this product ID
formatquery`csv` for a CSV file instead of JSON (csv)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/orders" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/orders/{id}Mark a physical order as shipped (or not), with a tracking link

The buyer gets an email the first time it's marked shipped, unless notify is false.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathOrder ID
Body fieldTypeDescription
fulfilmentstring (shipped, unfulfilled)
tracking_urlstring | null
notifyboolean
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/orders/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"fulfilment":"shipped","tracking_url":"https://track.example.com/123"}'
POST/profiles/{pid}/orders/{id}/resendEmail the buyer their link again
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathOrder ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/orders/{id}/resend" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/orders/{id}/refundRefund a PayPal order in full and switch its access off

Card payments are refunded in Stripe; access then switches off by itself.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathOrder ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/orders/{id}/refund" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/bookingsCoaching bookings, upcoming first
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/bookings" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/bookings/{id}/cancelCancel a booking and free the time

Refunds happen in Stripe.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBooking ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/bookings/{id}/cancel" \
  -H "Authorization: Bearer $KEY"

Discounts

GET/profiles/{pid}/discountsDiscount codes
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/discounts" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/discountsAdd a discount code
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
code *string3 to 32 letters, numbers, dashes or underscores; stored in capitals
kind *stringpercent: amount is 1-100. amount: amount is cents off (percent, amount)
amount *integer
currencystringFor amount codes (usd, eur, gbp, cad, aud, nzd)
product_idsarrayOnly these products. Empty = every product
expires_atinteger | nullUnix milliseconds; null = never
max_usesinteger | nullnull = no limit
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/discounts" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"code":"LAUNCH20","kind":"percent","amount":20,"max_uses":100}'
PATCH/profiles/{pid}/discounts/{id}Change a code, or switch it off with { active: false }
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathDiscount code ID
Body fieldTypeDescription
codestring3 to 32 letters, numbers, dashes or underscores; stored in capitals
kindstringpercent: amount is 1-100. amount: amount is cents off (percent, amount)
amountinteger
currencystringFor amount codes (usd, eur, gbp, cad, aud, nzd)
product_idsarrayOnly these products. Empty = every product
expires_atinteger | nullUnix milliseconds; null = never
max_usesinteger | nullnull = no limit
activeboolean
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/discounts/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":false}'
DELETE/profiles/{pid}/discounts/{id}Delete a discount code
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathDiscount code ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/discounts/{id}" \
  -H "Authorization: Bearer $KEY"

Affiliates

GET/profiles/{pid}/affiliatesAffiliates and buyer resellers, with clicks, sales and commission

Also the products that offer a commission and the program's sign-up page.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/affiliates" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/affiliates/{id}Approve, decline or reset an affiliate

The first approval emails them their links, when email is set up.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathAffiliate ID
Body fieldTypeDescription
status *string (approved, rejected, pending)
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/affiliates/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"approved"}'
POST/profiles/{pid}/affiliates/{id}/paidMark everything owed to an affiliate as paid

You pay affiliates yourself, by PayPal; this only records it.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathAffiliate ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/affiliates/{id}/paid" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/affiliates/commissionsCommission on each referred sale, newest first (up to 500; CSV has up to 5,000)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
formatquery`csv` for a CSV file instead of JSON (csv)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/affiliates/commissions" \
  -H "Authorization: Bearer $KEY"

Funnels

GET/profiles/{pid}/funnelsFunnels, with views, yes, no and revenue per step
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/funnels" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/funnelsAdd a funnel: up to 20 offers shown one at a time after someone buys the entry product
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
namestring
entry_product_id *stringA product can start only one funnel; while it does, the funnel replaces its upsell
enabledboolean
stepsarrayUp to 20 steps, in order. Replaces the list
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/funnels" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Launch","entry_product_id":"prod1","steps":[{"product_id":"prod2","headline":"Add the workbook","price_cents":900,"yes_action":"finish","no_action":"next"},{"product_id":"prod3","headline":"Or the mini guide","price_cents":500}]}'
GET/profiles/{pid}/funnels/{id}One funnel, with its stats
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFunnel ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/funnels/{id}" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/funnels/{id}Change a funnel

Send only the fields to change. steps replaces the whole list: keep each step's id to keep its stats.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFunnel ID
Body fieldTypeDescription
namestring
entry_product_idstringA product can start only one funnel; while it does, the funnel replaces its upsell
enabledboolean
stepsarrayUp to 20 steps, in order. Replaces the list
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/funnels/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'
DELETE/profiles/{pid}/funnels/{id}Delete a funnel

Orders bought through it are kept.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFunnel ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/funnels/{id}" \
  -H "Authorization: Bearer $KEY"

Email sync

GET/profiles/{pid}/email-syncThe connected email service, if any
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/email-sync" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/email-syncConnect an email service (replaces any old connection)

The key is checked with the service, encrypted, and never returned.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
provider *string (mailchimp, klaviyo, flodesk, kit)
apiKey *stringThe service's API key
listIdstringFrom POST /email-sync/test
consentOnlybooleanOnly send subscribers who ticked the consent box
doubleOptinbooleanAsk the service to confirm each address, where supported
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/email-sync" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"mailchimp","apiKey":"string","listId":"string","consentOnly":true,"doubleOptin":true}'
PATCH/profiles/{pid}/email-syncChange the list or options
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
listIdstring
consentOnlyboolean
doubleOptinboolean
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/email-sync" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"listId":"string","consentOnly":true,"doubleOptin":true}'
DELETE/profiles/{pid}/email-syncDisconnect the email service
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/email-sync" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/email-sync/testCheck a key and list its lists (nothing is saved)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
provider *string (mailchimp, klaviyo, flodesk, kit)
apiKey *string
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/email-sync/test" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"mailchimp","apiKey":"string"}'
GET/profiles/{pid}/email-sync/listsLists in the connected account
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/email-sync/lists" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/email-sync/enableSwitch a paused connection back on
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/email-sync/enable" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/email-sync/backfillSend one chunk of existing subscribers; repeat with the cursor until done
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
cursorstring | null
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/email-sync/backfill" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"cursor":"string"}'

Emails

GET/profiles/{pid}/emailsWhether sending is on, sender details, daily cap and unsubscribes
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/emails" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/emails/senderSender name, reply-to and postal address
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
from_namestring
reply_tostring
postal_address *stringRequired by anti-spam laws
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/emails/sender" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"from_name":"Maya","reply_to":"maya@example.com","postal_address":"12 Main St, London NW1 1AA, UK"}'
GET/profiles/{pid}/emails/audienceHow many people an audience reaches
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
audiencequeryall, consented, tag or product (all, consented, tag, product)
productqueryFor audience product
tagqueryFor audience tag
countriesqueryComma-separated ISO codes; leave out for all countries
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/emails/audience" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/emails/broadcastsBroadcasts, newest first
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/broadcastsStart a draft broadcast
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
subjectstring
previewstringPreview text shown after the subject in inboxes
bodystringHTML (sanitized). Every email gets an unsubscribe link and the sender's postal address
audiencestringall: every subscriber. consented: only those who ticked the consent box. tag: subscribers with `tag`. product: buyers of product_id (all, consented, tag, product)
product_idstring | nullFor audience product
tagstring | nullFor audience tag
countriesarrayOnly people who signed up from these countries. Empty: all countries, people with no recorded country included
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"New collection Friday","body":"<p>Hi! The new mugs go live Friday at 9.</p>","audience":"all"}'
GET/profiles/{pid}/emails/broadcasts/{id}One broadcast
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/emails/broadcasts/{id}Edit a draft or scheduled broadcast
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Body fieldTypeDescription
subjectstring
previewstringPreview text shown after the subject in inboxes
bodystringHTML (sanitized). Every email gets an unsubscribe link and the sender's postal address
audiencestringall: every subscriber. consented: only those who ticked the consent box. tag: subscribers with `tag`. product: buyers of product_id (all, consented, tag, product)
product_idstring | nullFor audience product
tagstring | nullFor audience tag
countriesarrayOnly people who signed up from these countries. Empty: all countries, people with no recorded country included
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","preview":"string","body":"string","audience":"all","product_id":"string","tag":"string","countries":["string"]}'
DELETE/profiles/{pid}/emails/broadcasts/{id}Delete a broadcast (not while sending)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/broadcasts/{id}/duplicateCopy a broadcast as a new draft
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}/duplicate" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/broadcasts/{id}/testSend a test to the account's own email
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}/test" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/broadcasts/{id}/sendSend to the audience now, or schedule it

Emails real subscribers. Needs sender details, a subject and a body.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Body fieldTypeDescription
atintegerUnix milliseconds; leave out to send now
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}/send" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"at":0}'
POST/profiles/{pid}/emails/broadcasts/{id}/cancelUnschedule (back to draft) or stop sending
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathBroadcast ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/broadcasts/{id}/cancel" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/emails/flowsAutomated flows, with their emails
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/flowsAdd a flow (switched off)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
namestring
trigger *stringsubscribed: someone joins the list. product: someone gets product_id (subscribed, product)
product_idstring | null
stepsarray
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Welcome","trigger":"subscribed","steps":[{"delay_minutes":0,"subject":"Welcome!","body":"<p>Thanks for joining.</p>"}]}'
PUT/profiles/{pid}/emails/flows/{id}Replace a flow's name, trigger and emails
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFlow ID
Body fieldTypeDescription
namestring
trigger *stringsubscribed: someone joins the list. product: someone gets product_id (subscribed, product)
product_idstring | null
steps *array
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","trigger":"subscribed","product_id":"string","steps":[{"id":"string","delay_minutes":0,"subject":"string","preview":"string","body":"string"}]}'
DELETE/profiles/{pid}/emails/flows/{id}Delete a flow
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFlow ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows/{id}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/emails/flows/{id}/enabledSwitch a flow on or off
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFlow ID
Body fieldTypeDescription
enabled *boolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows/{id}/enabled" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'
POST/profiles/{pid}/emails/flows/{id}/steps/{stepId}/testSend one flow email to the account's own email
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathFlow ID
stepId *pathFlow step ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/emails/flows/{id}/steps/{stepId}/test" \
  -H "Authorization: Bearer $KEY"

Media kit

GET/profiles/{pid}/kitThe profile's media kit, with fresh audience numbers
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/kit" \
  -H "Authorization: Bearer $KEY"
PUT/profiles/{pid}/kitSave the media kit (creates it the first time)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
dataobjectheadline, intro, niches, platforms, rates, partners, testimonials, contact, show. Replaces the stored data
hiddenbooleanHide the public kit page
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/kit" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"hidden":false}'
POST/profiles/{pid}/kit/refreshWork out the audience numbers again (at most every 10 minutes)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/kit/refresh" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/kit/passwordSet (at least 4 characters) or remove (null) the media kit's password
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
password *string | null
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/kit/password" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"password":"brands-only"}'
POST/profiles/{pid}/kit/featured-previewTitle and thumbnail for a featured post or video link (nothing is saved)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
url *string
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/kit/featured-preview" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=dQw4w9WgXcQ"}'
GET/profiles/{pid}/invoicesThe profile's invoices (newest first), each with its private link, and the account's business details
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/invoices" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/invoicesMake an invoice with the account's next number. Items are { description, qty, unit } with unit in cents (minor units)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
client_name *string
client_emailstring
currencystring
tax_percentnumber
issue_datestringYYYY-MM-DD
due_datestringYYYY-MM-DD
notesstring
items *array
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/invoices" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"client_name":"Acme Clay","items":[{"description":"1 Instagram reel","qty":1,"unit":50000}]}'
PUT/profiles/{pid}/invoices/businessSave the business details printed on invoices (once per account)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
business *objectname, address, email, tax_id, paypal (paypal.me name or PayPal email), prefix
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/invoices/business" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"business":{"name":"Maya Studio"}}'
PUT/profiles/{pid}/invoices/{id}Edit an invoice (same fields as creating one)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathInvoice ID
Body fieldTypeDescription
client_name *string
items *array
Example request
curl -X PUT "https://linkdeck.link/api/v1/profiles/{pid}/invoices/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"client_name":"Acme Clay","items":[{"description":"1 Instagram reel","qty":1,"unit":50000}]}'
DELETE/profiles/{pid}/invoices/{id}Delete an invoice (its number isn't reused)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathInvoice ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/invoices/{id}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/invoices/{id}/paidMark an invoice paid or unpaid
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathInvoice ID
Body fieldTypeDescription
paidboolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/invoices/{id}/paid" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"paid":true}'

AI

POST/profiles/{pid}/kit/pitchDraft an outreach email to a brand from the media kit (beta, uses AI credits)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
brand *string
ideastring
tonestring
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/kit/pitch" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"brand":"Acme Clay","idea":"A glaze tutorial series"}'
GET/profiles/{pid}/ai/creditsAI credits left today
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/ai/credits" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/ai/writeSuggest text (beta, uses AI credits)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
kind *string (bio, link_title, product_description, email_subject, email_body, kit_headline, kit_intro, caption)
goalstring
tonestring
currentstringText to improve
contextstring
platformstringFor captions
hashtagsboolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/ai/write" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"bio","goal":"Ceramicist selling mugs and running workshops"}'
POST/profiles/{pid}/ai/designSuggest a page design to preview (beta, uses AI credits; nothing changes yet)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
about *stringA sentence about you
goalstring
vibestring
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/ai/design" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"about":"string","goal":"string","vibe":"string"}'
POST/profiles/{pid}/ai/design/applyApply a design suggestion

replace saves a version first.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
suggestion *object
mode *string (add, replace)
bioboolean
themeboolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/ai/design/apply" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"suggestion":{},"mode":"add","bio":true,"theme":true}'

Planner

GET/profiles/{pid}/planner/postsPlanned, posted and draft social posts
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/planner/postsAdd a post (a draft, or scheduled)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
statusstringdraft (nothing happens at the time), scheduled (needs platforms and local_time) or pending_approval (like scheduled, but waits for a team approver) (draft, scheduled, pending_approval)
platformsarray
captionstring
titlestringYouTube Shorts and Pinterest
first_commentstring
mediaarray
ig_kindstring (feed, story)
alt_textstring
auto_publishbooleanPost automatically at the time on connected platforms; otherwise you get a reminder
email_reminderboolean
optionsobject{ pinterest?: { board_id }, tiktok?: { privacy_level }, youtube?: { privacy: public|unlisted|private } }
local_timestring | nullYYYY-MM-DDTHH:mm in timezone; null for no date
timezonestringIANA time zone, e.g. Europe/Lisbon
bio_linkobject | null{ block_id } or { title, url }: a link put on the bio page when it posts
grid_linkstring | nullWhere the post's tile on a postgrid block goes
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","platforms":["instagram"],"caption":"New mugs Friday!","local_time":"2026-12-04T18:00","timezone":"Europe/London"}'
GET/profiles/{pid}/planner/posts/{id}One post, with each platform's delivery
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathPlanner post ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts/{id}" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/planner/posts/{id}Save a post

Send the whole post: fields left out are cleared. Changing the time or going back to draft starts its deliveries again.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathPlanner post ID
Body fieldTypeDescription
statusstringdraft (nothing happens at the time), scheduled (needs platforms and local_time) or pending_approval (like scheduled, but waits for a team approver) (draft, scheduled, pending_approval)
platformsarray
captionstring
titlestringYouTube Shorts and Pinterest
first_commentstring
mediaarray
ig_kindstring (feed, story)
alt_textstring
auto_publishbooleanPost automatically at the time on connected platforms; otherwise you get a reminder
email_reminderboolean
optionsobject{ pinterest?: { board_id }, tiktok?: { privacy_level }, youtube?: { privacy: public|unlisted|private } }
local_timestring | nullYYYY-MM-DDTHH:mm in timezone; null for no date
timezonestringIANA time zone, e.g. Europe/Lisbon
bio_linkobject | null{ block_id } or { title, url }: a link put on the bio page when it posts
grid_linkstring | nullWhere the post's tile on a postgrid block goes
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","platforms":["instagram"],"caption":"string","title":"string","first_comment":"string","media":[{"key":"string"}],"ig_kind":"feed","alt_text":"string","auto_publish":true,"email_reminder":true,"options":{},"local_time":"string","timezone":"string","bio_link":{},"grid_link":"string"}'
DELETE/profiles/{pid}/planner/posts/{id}Delete a post
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathPlanner post ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts/{id}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/planner/posts/{id}/postedTick (or untick) a platform as posted by hand
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathPlanner post ID
Body fieldTypeDescription
platform *string (instagram, tiktok, youtube_shorts, x, linkedin, facebook, threads, pinterest, other)
posted *boolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts/{id}/posted" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"instagram","posted":true}'
POST/profiles/{pid}/planner/posts/{id}/duplicateCopy a post as an undated draft
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
id *pathPlanner post ID
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/planner/posts/{id}/duplicate" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/planner/badgeUnread planner notifications
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/planner/badge" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/planner/notificationsReminders and published or failed posts
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/planner/notifications" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/planner/notifications/readMark notifications read (all, or the ids given)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Body fieldTypeDescription
idsarray
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/planner/notifications/read" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
GET/profiles/{pid}/planner/connectionsPublishing platforms and whether each is connected

Connecting a platform happens in the dashboard (it signs in with that platform).

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
quotaqueryAny value: include Instagram's posts-per-day count
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/planner/connections" \
  -H "Authorization: Bearer $KEY"
PATCH/profiles/{pid}/planner/connections/{platform}Facebook: post to another of your Pages. Pinterest: reload the boards
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
platform *pathPlatform: instagram, tiktok, youtube_shorts, x, linkedin, facebook, threads, pinterest, other
Body fieldTypeDescription
page_idstringFacebook only
Example request
curl -X PATCH "https://linkdeck.link/api/v1/profiles/{pid}/planner/connections/{platform}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"page_id":"string"}'
DELETE/profiles/{pid}/planner/connections/{platform}Disconnect a publishing platform
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
platform *pathPlatform: instagram, tiktok, youtube_shorts, x, linkedin, facebook, threads, pinterest, other
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/planner/connections/{platform}" \
  -H "Authorization: Bearer $KEY"

Instagram

GET/profiles/{pid}/inboxInstagram DMs and posts with comments, with unread counts
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/inbox" \
  -H "Authorization: Bearer $KEY"
GET/profiles/{pid}/inbox/dm/{thread}One DM conversation (marks it read)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
thread *pathConversation ID, from GET /inbox
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/inbox/dm/{thread}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/inbox/dm/{thread}/replyReply to a DM, as you

Sends a real Instagram message. Needs the Instagram webhook switched on.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
thread *pathConversation ID, from GET /inbox
Body fieldTypeDescription
text *string
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/inbox/dm/{thread}/reply" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string"}'
GET/profiles/{pid}/inbox/posts/{mediaId}A post's comments (marks them read)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
mediaId *pathInstagram post ID
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/inbox/posts/{mediaId}" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/inbox/comments/{commentId}/replyReply to a comment publicly, or privately by DM
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
commentId *pathInstagram comment ID
Body fieldTypeDescription
text *string
privatebooleanReply by DM instead
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/inbox/comments/{commentId}/reply" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","private":true}'
POST/profiles/{pid}/inbox/comments/{commentId}/hideHide (or unhide) a comment
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
commentId *pathInstagram comment ID
Body fieldTypeDescription
hiddenboolean
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/inbox/comments/{commentId}/hide" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"hidden":true}'
GET/profiles/{pid}/instagram/postsInstagram posts with reach, likes, comments, saves and shares
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/instagram/posts" \
  -H "Authorization: Bearer $KEY"
POST/profiles/{pid}/instagram/posts/refreshFetch the numbers again now (at most once an hour)
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X POST "https://linkdeck.link/api/v1/profiles/{pid}/instagram/posts/refresh" \
  -H "Authorization: Bearer $KEY"
GET/short-links/{id}/statsClicks per day, top referrers, countries and devices
ParameterInDescription
id *pathShort link ID (not its code)
fromqueryStart, in Unix milliseconds. Default: 30 days ago
Example request
curl "https://linkdeck.link/api/v1/short-links/{id}/stats" \
  -H "Authorization: Bearer $KEY"
GET/short-links/{id}/clicks.csvOne link's clicks, newest first (up to 50,000), as CSV
ParameterInDescription
id *pathShort link ID (not its code)
Example request
curl "https://linkdeck.link/api/v1/short-links/{id}/clicks.csv" \
  -H "Authorization: Bearer $KEY"

QR codes

GET/qrYour QR codes, with scan counts
Example request
curl "https://linkdeck.link/api/v1/qr" \
  -H "Authorization: Bearer $KEY"
POST/qrCreate a dynamic QR code
Body fieldTypeDescription
target_url *stringWhere the code goes
namestring
profile_idstringOptional profile to file it under
styleobject
Example request
curl -X POST "https://linkdeck.link/api/v1/qr" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Market stall","target_url":"https://example.com/maya"}'
PATCH/qr/{id}Change a QR code's destination, name or style
ParameterInDescription
id *pathQR code ID
Body fieldTypeDescription
target_urlstring
namestring
profile_idstring | null
styleobject
Example request
curl -X PATCH "https://linkdeck.link/api/v1/qr/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"target_url":"https://example.com/new"}'
DELETE/qr/{id}Delete a QR code
ParameterInDescription
id *pathQR code ID
Example request
curl -X DELETE "https://linkdeck.link/api/v1/qr/{id}" \
  -H "Authorization: Bearer $KEY"
GET/qr/{id}/statsScans per day
ParameterInDescription
id *pathQR code ID
fromqueryStart, in Unix milliseconds. Default: 30 days ago
Example request
curl "https://linkdeck.link/api/v1/qr/{id}/stats" \
  -H "Authorization: Bearer $KEY"

Webhooks

GET/profiles/{pid}/webhooksWebhooks on this profile
ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl "https://linkdeck.link/api/v1/profiles/{pid}/webhooks" \
  -H "Authorization: Bearer $KEY"

Themes

GET/themesYour saved themes, with the profiles linked to each
Example request
curl "https://linkdeck.link/api/v1/themes" \
  -H "Authorization: Bearer $KEY"
POST/themesSave a theme

From a profile's current look (profile_id), or from a theme object. Up to 50.

Body fieldTypeDescription
name *string
profile_idstringSave this profile's current look
themeobjectOr a theme object, cleaned like a profile's
Example request
curl -X POST "https://linkdeck.link/api/v1/themes" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Brand","profile_id":"abc123"}'
PATCH/themes/{id}Rename a saved theme, or change its look

A new look (theme, or profile_id to copy that profile's look) is pushed to every linked profile, saving a version of each first; the profile it came from is linked too. Profiles that can't be edited are listed in skipped.

ParameterInDescription
id *pathSaved theme ID (from GET /themes)
Body fieldTypeDescription
namestring
profile_idstringCopy this profile's current look
themeobject
Example request
curl -X PATCH "https://linkdeck.link/api/v1/themes/{id}" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"profile_id":"abc123"}'
DELETE/themes/{id}Delete a saved theme

Linked profiles keep their look and are unlinked.

ParameterInDescription
id *pathSaved theme ID (from GET /themes)
Example request
curl -X DELETE "https://linkdeck.link/api/v1/themes/{id}" \
  -H "Authorization: Bearer $KEY"
POST/themes/{id}/duplicateCopy a saved theme
ParameterInDescription
id *pathSaved theme ID (from GET /themes)
Body fieldTypeDescription
namestringDefault: the name plus "copy"
Example request
curl -X POST "https://linkdeck.link/api/v1/themes/{id}/duplicate" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
POST/themes/{id}/applyApply a saved theme to profiles

Replaces each profile's look, saving a version first so it can be undone. sync: true keeps them linked, so updating the theme updates them; false unlinks them. Profiles that can't be edited are listed in skipped.

ParameterInDescription
id *pathSaved theme ID (from GET /themes)
Body fieldTypeDescription
profile_ids *arrayUp to 500
syncbooleanKeep these profiles in sync with the theme
Example request
curl -X POST "https://linkdeck.link/api/v1/themes/{id}/apply" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"profile_ids":["abc123","def456"],"sync":true}'
DELETE/profiles/{pid}/theme-linkStop keeping a profile in sync with its saved theme

The profile keeps its current look.

ParameterInDescription
pid *pathProfile ID (from GET /profiles)
Example request
curl -X DELETE "https://linkdeck.link/api/v1/profiles/{pid}/theme-link" \
  -H "Authorization: Bearer $KEY"