Skip to main content
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"
    }
  ]
}
'
{
  "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"
}
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

​
card
string
required
The ID of the card for which to generate a URL
​
integrationId
string
required
Integration configuration ID that links to your workflow settings
​
mergeTags
array
required
Array containing recipient data for personalization. Must include at least one object with recipient information.

​
Response Details

​
view_card_url
string
Direct URL to view the personalized card
​
white_label_app_name
string
The app name shown in the card (usually “CardClan” unless white-labeled)
​
card_cover
string
URL to the card’s cover image/thumbnail
​
unsubscribe_link_url
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

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"