Get Card URL

curl --request POST \
  --url https://app.cardclan.io/api/integration/get-card-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card": "60f7b2b5b8f4a20015a4f5a5",
  "integrationId": "60f7b2b5b8f4a20015a4f5a7",
  "mergeTags": [
    {
      "name": "John Doe",
      "email": "john@example.com",
      "company": "Acme Corp",
      "position": "Marketing Manager"
    }
  ]
}
'

import requests

url = "https://app.cardclan.io/api/integration/get-card-url"

payload = {
    "card": "60f7b2b5b8f4a20015a4f5a5",
    "integrationId": "60f7b2b5b8f4a20015a4f5a7",
    "mergeTags": [
        {
            "name": "John Doe",
            "email": "john@example.com",
            "company": "Acme Corp",
            "position": "Marketing Manager"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    card: '60f7b2b5b8f4a20015a4f5a5',
    integrationId: '60f7b2b5b8f4a20015a4f5a7',
    mergeTags: [
      {
        name: 'John Doe',
        email: 'john@example.com',
        company: 'Acme Corp',
        position: 'Marketing Manager'
      }
    ]
  })
};

fetch('https://app.cardclan.io/api/integration/get-card-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.cardclan.io/api/integration/get-card-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'card' => '60f7b2b5b8f4a20015a4f5a5',
    'integrationId' => '60f7b2b5b8f4a20015a4f5a7',
    'mergeTags' => [
        [
                'name' => 'John Doe',
                'email' => 'john@example.com',
                'company' => 'Acme Corp',
                'position' => 'Marketing Manager'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.cardclan.io/api/integration/get-card-url"

	payload := strings.NewReader("{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.cardclan.io/api/integration/get-card-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.cardclan.io/api/integration/get-card-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "view_card_url": "https://cardclan.com/view/60f7b2b5b8f4a20015a4f5a8",
  "white_label_app_name": "CardClan",
  "card_cover": "https://cdn.cardclan.com/covers/card-cover.jpg",
  "unsubscribe_link_url": "https://cardclan.com/unsubscribe/60f7b2b5b8f4a20015a4f5a8"
}

{
  "error": "Bad Request",
  "message": "Card ID is required",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

POST

integration

get-card-url

Get Card URL

curl --request POST \
  --url https://app.cardclan.io/api/integration/get-card-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "card": "60f7b2b5b8f4a20015a4f5a5",
  "integrationId": "60f7b2b5b8f4a20015a4f5a7",
  "mergeTags": [
    {
      "name": "John Doe",
      "email": "john@example.com",
      "company": "Acme Corp",
      "position": "Marketing Manager"
    }
  ]
}
'

import requests

url = "https://app.cardclan.io/api/integration/get-card-url"

payload = {
    "card": "60f7b2b5b8f4a20015a4f5a5",
    "integrationId": "60f7b2b5b8f4a20015a4f5a7",
    "mergeTags": [
        {
            "name": "John Doe",
            "email": "john@example.com",
            "company": "Acme Corp",
            "position": "Marketing Manager"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    card: '60f7b2b5b8f4a20015a4f5a5',
    integrationId: '60f7b2b5b8f4a20015a4f5a7',
    mergeTags: [
      {
        name: 'John Doe',
        email: 'john@example.com',
        company: 'Acme Corp',
        position: 'Marketing Manager'
      }
    ]
  })
};

fetch('https://app.cardclan.io/api/integration/get-card-url', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.cardclan.io/api/integration/get-card-url",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'card' => '60f7b2b5b8f4a20015a4f5a5',
    'integrationId' => '60f7b2b5b8f4a20015a4f5a7',
    'mergeTags' => [
        [
                'name' => 'John Doe',
                'email' => 'john@example.com',
                'company' => 'Acme Corp',
                'position' => 'Marketing Manager'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.cardclan.io/api/integration/get-card-url"

	payload := strings.NewReader("{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.cardclan.io/api/integration/get-card-url")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.cardclan.io/api/integration/get-card-url")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"card\": \"60f7b2b5b8f4a20015a4f5a5\",\n  \"integrationId\": \"60f7b2b5b8f4a20015a4f5a7\",\n  \"mergeTags\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"john@example.com\",\n      \"company\": \"Acme Corp\",\n      \"position\": \"Marketing Manager\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "view_card_url": "https://cardclan.com/view/60f7b2b5b8f4a20015a4f5a8",
  "white_label_app_name": "CardClan",
  "card_cover": "https://cdn.cardclan.com/covers/card-cover.jpg",
  "unsubscribe_link_url": "https://cardclan.com/unsubscribe/60f7b2b5b8f4a20015a4f5a8"
}

{
  "error": "Bad Request",
  "message": "Card ID is required",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Generates a personalized card URL without sending an email. This is useful when you want to share card links through channels other than email, such as SMS, social media, or direct messaging platforms.

Key Differences from Send Card

No Email Delivery: Creates a URL instead of sending an email
Same Personalization: Uses merge tags to personalize the card content
Flexible Distribution: You can share the URL through any channel
Analytics Tracking: Still provides tracking capabilities through the URL

Request Parameters

string

required

The ID of the card for which to generate a URL

string

required

Integration configuration ID that links to your workflow settings

array

required

Array containing recipient data for personalization. Must include at least one object with recipient information.

Response Details

string

Direct URL to view the personalized card

string

The app name shown in the card (usually “CardClan” unless white-labeled)

string

URL to the card’s cover image/thumbnail

string

URL for recipients to unsubscribe from future cards

Response Example

{
  "view_card_url": "https://app.cardclan.io/view/card/abc123def456?token=xyz789",
  "white_label_app_name": "CardClan",
  "card_cover": "https://cdn.cardclan.io/cards/covers/60f7b2b5b8f4a20015a4f5a5.png",
  "unsubscribe_link_url": "https://app.cardclan.io/unsubscribe?email=john@example.com&token=unsubscribe123"
}

Authorizations

Authorization

string

header

required

Enter your CardClan integration key

Body

application/json

card

string

required

Card ID for URL generation

Example:

"60f7b2b5b8f4a20015a4f5a5"

integrationId

string

required

Integration configuration ID

Example:

"60f7b2b5b8f4a20015a4f5a7"

mergeTags

object[]

required

Array of merge tag objects with recipient data

Minimum array length: 1

Show child attributes

Response

Card URL generated successfully

view_card_url

string

Example:

"https://cardclan.com/view/60f7b2b5b8f4a20015a4f5a8"

white_label_app_name

string

Example:

"CardClan"

card_cover

string

Example:

"https://cdn.cardclan.com/covers/card-cover.jpg"

unsubscribe_link_url

string

Example:

"https://cardclan.com/unsubscribe/60f7b2b5b8f4a20015a4f5a8"

Getting Started

Integration API

Zapier API (Coming Soon)

Get Card URL

Key Differences from Send Card

Request Parameters

Response Details

Response Example

Authorizations

Body

Response

​Key Differences from Send Card

​Request Parameters

​Response Details

​Response Example

Authorizations

Body

Response

Key Differences from Send Card

Request Parameters

Response Details

Response Example