---
canonical_url: "https://docs.composio.dev/toolkits/cardclan"
markdown_url: "https://docs.composio.dev/toolkits/cardclan.md"
product: "platform"
version: null
last_updated: null
---

# CardClan

CardClan helps teams personalize and send digital cards, generate card links, and manage card integration workflows.

- **Category:** marketing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `CARDCLAN`
- **Version:** 00000000_00

## Tools

### Create Integration Configuration

**Slug:** `CARDCLAN_CREATE_INTEGRATION_CONFIG`

Create a persistent CardClan integration configuration linking a card to its workspace. The connected user's ID is resolved automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | Yes | Card ID from that workspace, returned by CARDCLAN_LIST_CARDS. |
| `workspace_id` | string | Yes | Workspace ID returned by CARDCLAN_LIST_WORKSPACES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Personalized Card URL

**Slug:** `CARDCLAN_GENERATE_CARD_URL`

Generate a personalized CardClan viewing URL without sending an email. This may create recipient-specific CardClan state but does not deliver a message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | Yes | Card ID to personalize. |
| `recipients` | array | Yes | Non-empty recipient list. Each recipient requires name and email; company and position are optional. Add any card-specific merge tags as additional string fields on that recipient. |
| `integration_id` | string | Yes | Integration configuration ID for the card. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Card Details

**Slug:** `CARDCLAN_GET_CARD_DETAILS`

Get a CardClan card's title, merge-tag requirements, and owning workspace details by card ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | Yes | Card ID returned by CARDCLAN_LIST_CARDS or CARDCLAN_LIST_WORKFLOW_CARDS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Integration Configuration

**Slug:** `CARDCLAN_GET_INTEGRATION_CONFIG`

Get a CardClan integration configuration by either integration ID or card ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | No | Card ID whose integration configuration should be retrieved. Provide exactly one of card_id or integration_id. |
| `integration_id` | string | No | Integration configuration ID. Provide exactly one of integration_id or card_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Cards

**Slug:** `CARDCLAN_LIST_CARDS`

List cards in a CardClan workspace, including card IDs needed for details, integration configuration, personalized links, and sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID returned by CARDCLAN_LIST_WORKSPACES. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Accounts

**Slug:** `CARDCLAN_LIST_EMAIL_ACCOUNTS`

List configured CardClan sender accounts that can be selected when sending a card.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflow Cards

**Slug:** `CARDCLAN_LIST_WORKFLOW_CARDS`

List cards with active CardClan integration workflows and return their integration, card, and workspace IDs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `CARDCLAN_LIST_WORKSPACES`

List CardClan workspaces accessible to the connected account, including the workspace IDs needed to find cards and create integration configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Card

**Slug:** `CARDCLAN_SEND_CARD`

Immediately personalize and send a CardClan card by email to one or more recipients. This externally side-effecting operation is irreversible; use GENERATE_CARD_URL when delivery is not intended.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `card_id` | string | Yes | Card ID to personalize and send. |
| `recipients` | array | Yes | Recipients to personalize and email. Each recipient requires name and email; additional card merge-tag values must be strings. |
| `confirm_send` | boolean | Yes | Must be true to confirm immediate external email delivery. This value is validated locally and is not sent to CardClan. |
| `integration_id` | string | Yes | Integration configuration ID for the card. |
| `email_account_id` | string | No | Configured sender account ID from CARDCLAN_LIST_EMAIL_ACCOUNTS, or CardClan to use the default sender. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |