Skip to main content
POST
/
integration
/
send-card
Send Card
curl --request POST \
  --url https://app.cardclan.io/api/integration/send-card \
  --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"
    }
  ],
  "emailAccount": "CardClan"
}
'
{
  "message": "Card successfully sent to recipient: john@example.com",
  "status": true,
  "recipient_id": "60f7b2b5b8f4a20015a4f5a8",
  "tracking_url": "https://cardclan.com/api/analytics/fetchImage/60f7b2b5b8f4a20015a4f5a8"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cardclan.io/llms.txt

Use this file to discover all available pages before exploring further.

Sends a personalized card to a recipient via email. This is the core action endpoint that delivers your cards with dynamic content based on merge tags.

​
Key Features

  • Personalization: Replace merge tags with recipient-specific data
  • Email Delivery: Send via your configured email accounts or CardClan’s default
  • Tracking: Get unique tracking URLs for engagement analytics
  • Error Handling: Robust validation and error reporting

​
Request Parameters

​
card
string
required
The ID of the card you want to send. Get available cards using the Get Cards endpoint.
​
integrationId
string
required
Integration configuration ID that links your card to workflow settings. Create one using the Create Integration Config endpoint.
​
mergeTags
array
required
Array containing recipient data for personalization. Must contain at least one object with name and email fields.
​
emailAccount
string
Email account to send from. Use "CardClan" for default CardClan email, or provide an email account ID from Get Email Accounts.

​
Response Details

​
message
string
Human-readable success or failure message
​
status
boolean
true if card was sent successfully, false if sending failed
​
recipient_id
string
Unique identifier for this card delivery instance, used for tracking
​
tracking_url
string
URL that tracks when the recipient opens the card email

​
Response Example

​
Success Response

{
  "message": "Card sent successfully!",
  "status": true,
  "recipient_id": "60f7b2b5b8f4a20015a4f5a9",
  "tracking_url": "https://app.cardclan.io/track/email/abc123def456"
}

​
Error Response

{
  "message": "Card sending failed: Invalid email address",
  "status": false
}

Authorizations

​
Authorization
string
header
required

Enter your CardClan integration key

Body

application/json
​
card
string
required

Card ID to send

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
​
emailAccount
string

Email account ID or 'CardClan' for default

Example:

"CardClan"

Response

Card sent successfully

​
message
string
Example:

"Card successfully sent to recipient: john@example.com"

​
status
boolean
Example:

true

​
recipient_id
string
Example:

"60f7b2b5b8f4a20015a4f5a8"

​
tracking_url
string
Example:

"https://cardclan.com/api/analytics/fetchImage/60f7b2b5b8f4a20015a4f5a8"