# Cardly

```json
{
  "name": "Cardly",
  "slug": "cardly",
  "url": "https://composio.dev/toolkits/cardly",
  "markdown_url": "https://composio.dev/toolkits/cardly.md",
  "logo_url": "https://logos.composio.dev/api/cardly",
  "categories": [
    "marketing & social media"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-05-12T10:05:45.764Z"
}
```

![Cardly logo](https://logos.composio.dev/api/cardly)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Cardly MCP or direct API to send personalized cards, automate mail campaigns, track delivery status, and manage customer outreach through natural language.

## Summary

Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes.

## Categories

- marketing & social media

## Toolkit Details

- Tools: 29

## Images

- Logo: https://logos.composio.dev/api/cardly

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Cardly.
  - Setup:
    - Configure Api Key credentials for Cardly.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Create a new contact list named 'VIP Clients'
- List all available artwork for our next campaign
- Generate a preview of a card using latest artwork
- Review recent credit history for this account

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `CARDLY_CREATE_CONTACT_LIST` | Create Contact List | Tool to add a new contact list. Use after defining name and optional custom fields, before populating the list with contacts. |
| `CARDLY_CREATE_INVITATION` | Create Invitation | Tool to send an invitation to use your organisation portal. Use when you need to grant access to a new user by their email address. If the email already has access, the API will return an appropriate error. |
| `CARDLY_CREATE_WEBHOOK` | Create Webhook | Tool to create a new webhook subscription. Use when you need Cardly to notify your application via HTTP POST for specific events. |
| `CARDLY_DELETE_INVITATION` | Delete Invitation | Tool to delete an invitation by unique ID, immediately invalidating it for acceptance. Use when you need to revoke a pending invitation using its ID. |
| `CARDLY_DELETE_INVITATION_BY_EMAIL` | Delete Invitation by Email | Deletes a pending invitation by email address, immediately invalidating it and preventing acceptance. This action is idempotent - deleting a non-existent invitation returns success. Use when you need to revoke access before an invitation is accepted, such as when correcting mistakes or revoking access for security reasons. Note: In test mode, the API returns an empty data object instead of the deleted invitation details. |
| `CARDLY_DELETE_USER` | Delete User | Tool to delete a user by unique ID, immediately revoking their access to your organisation portal. Use when removing user access is required. Cannot remove users with administrator privileges - attempting to delete an admin will fail. |
| `CARDLY_DELETE_USER_BY_EMAIL` | Delete User by Email | Deletes a user by email address, immediately revoking their access to your organisation portal. This action cannot remove users with administrator privileges. Use when you need to revoke user access, such as when employees leave or access needs to be terminated. The API returns a 404 if no matching user is found. |
| `CARDLY_DELETE_WEBHOOK` | Delete Webhook | Tool to delete a webhook. Use after confirming the webhook ID to immediately cease all activity and event subscriptions for that webhook. |
| `CARDLY_ECHO_REQUEST` | Echo Request | Tool to echo all request parameters, body, and headers for debugging purposes. Use when validating authentication or testing API connectivity without affecting account data. |
| `CARDLY_GENERATE_PREVIEW` | Generate Preview | Tool to generate a low-quality, watermarked preview document for a card. Use after confirming artwork and template details to estimate costs and delivery. |
| `CARDLY_GET_ARTWORK` | Get Artwork | Tool to retrieve information on a specific piece of artwork by its unique ID. Use when you need to fetch detailed artwork data including preview images, media specifications, and metadata. The ID can be obtained from the List Artwork action. |
| `CARDLY_GET_WEBHOOK` | Get Webhook | Tool to get details on an existing webhook. Use this to retrieve information about a webhook's configuration, including its target URL, subscribed events, status, and metadata. |
| `CARDLY_LIST_ARTWORK` | List Artwork | Tool to retrieve the currently available artwork for your organisation. Use when you need to list and paginate artwork items, optionally filtering to only your own artwork. |
| `CARDLY_LIST_CONTACT_LISTS` | List Contact Lists | Tool to retrieve all active contact lists for your organization. Use when you need to list and paginate contact lists with their custom fields and automation rules. |
| `CARDLY_LIST_CREDIT_HISTORY` | List Credit History | Retrieves the account's credit transaction history showing all credits and debits. Returns a paginated list of balance changes with timestamps, amounts, and descriptions. Use to audit spending, review signup bonuses, track refunds, or investigate balance changes. Filter by date range using effectiveTime parameters. Supports standard pagination with limit and offset. |
| `CARDLY_LIST_DOODLES` | List Doodles | Retrieve your currently available doodles from Cardly. Returns doodle metadata including name and restriction status. Use this to discover available doodle designs before creating cards. |
| `CARDLY_LIST_FONTS` | List Fonts | List available fonts for handwriting and text personalization in Cardly cards. Returns font metadata including name, category, variants, and whether the font supports humanisation. Use this to discover font options before creating cards or generating previews. |
| `CARDLY_LIST_GIFT_CREDIT_HISTORY` | List Gift Credit History | Lists gift credit history records for your organization with pagination and optional time-based filtering. Gift credits are promotional credits that can be applied to orders. This action retrieves a history of gift credit additions, deductions, and balance changes. Returns empty results if no gift credit history exists. |
| `CARDLY_LIST_INVITATIONS` | List Invitations | Tool to retrieve active invitations for your organisation with optional filters. Use when you need to audit invited users and their statuses before sending new invitations or revoking access. |
| `CARDLY_LIST_MEDIA` | List Media | Tool to retrieve the currently available media sizes for product artwork. Use when you need to explore or validate media options before creating artwork. |
| `CARDLY_LIST_ORDERS` | List Orders | Retrieves a paginated list of orders placed by your organization. Returns detailed order information including customer details, costs, items, shipping info, and delivery tracking. Use optional limit and offset parameters to control pagination. |
| `CARDLY_LIST_TEMPLATES` | List Templates | Tool to retrieve your currently available templates from Cardly. Use to list and paginate templates for selection in card sends. |
| `CARDLY_LIST_USERS` | List Users | Tool to retrieve all users associated with your account. Use when you need to list and paginate user accounts. |
| `CARDLY_LIST_WEBHOOKS` | List Webhooks | Retrieves all webhooks configured for your organization, including their status, target URLs, subscribed events, and delivery statistics. Use this to audit existing webhooks, monitor their health, or get webhook IDs for updates/deletions. |
| `CARDLY_LIST_WRITING_STYLES` | List Writing Styles | Tool to list available writing styles. Use when you need to retrieve writing styles available for handwriting personalization. |
| `CARDLY_RETRIEVE_ACCOUNT_BALANCE` | Retrieve Account Balance | Tool to retrieve the current account and gift credit balances for your organisation. Use after authenticating to verify available credit before placing orders. |
| `CARDLY_RETRIEVE_ORDER` | Retrieve Order | Retrieves detailed information about a specific order by its ID. Returns complete order data including customer details, items, costs, delivery information, and tracking details. Use this after obtaining an order ID from the List Orders action or from a known order reference. |
| `CARDLY_RETRIEVE_USER` | Retrieve User | Retrieves detailed information about a specific user account by ID. Returns user profile data including name, email, status, and permissions. Use list_users to get available user IDs first. |
| `CARDLY_UPDATE_WEBHOOK` | Update Webhook | Tool to update a webhook’s settings, including target URL and events. Use after retrieving existing webhook to apply configuration changes. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Cardly Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Cardly actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Create a new contact list for holiday campaign'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Create a new contact list for holiday campaign'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK and Claude Agent SDK
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Create Tool Router Session

Initialize the Composio client and create a Tool Router session
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });

console.log("Creating Tool Router session...");
const { mcp } = await composio.create('your-user-id');
console.log(`Tool Router session created: ${mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Cardly tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Create a new contact list named Holiday Campaign')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText, stepCountIs } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: mcp.url,
    headers: { 'x-api-key': 'your-composio-api-key' }
  }
});

const tools = await client.tools();

const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{ role: 'user', content: 'Create a new contact list named Holiday Campaign' }],
  stopWhen: stepCountIs( 5 )
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Cardly Integration

- Supports both Cardly MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for sending, tracking, and managing Cardly mail campaigns

### 2. Managed Auth

- Seamless API key handling with secure storage
- Central place to manage, scope, and revoke Cardly credentials
- No more hard-coded keys or scattered secrets

### 3. Agent Optimized Design

- Tools fine-tuned for AI reliability and success
- Comprehensive execution logs so you always know which mail went out and when

### 4. Enterprise Grade Security

- Granular RBAC so you control which agents and users can access Cardly
- Scoped, least privilege access to customer and campaign data
- Full audit trail of who sent what, and when, for compliance

## Use Cardly with any AI Agent Framework

Choose a framework you want to connect Cardly with:

- [OpenAI Agents SDK](https://composio.dev/toolkits/cardly/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/cardly/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/cardly/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/cardly/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/cardly/framework/codex)
- [OpenClaw](https://composio.dev/toolkits/cardly/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/cardly/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/cardly/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/cardly/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/cardly/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/cardly/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/cardly/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/cardly/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/cardly/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/cardly/framework/autogen)

## Related Toolkits

- [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing.
- [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages.
- [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections.
- [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach.
- [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease.
- [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic.
- [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns.
- [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active.
- [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place.
- [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES.
- [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere.
- [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools.
- [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools.
- [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management.
- [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals.
- [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams.
- [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience.
- [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs.
- [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics.
- [Doppler marketing automation](https://composio.dev/toolkits/doppler_marketing_automation) - Doppler marketing automation is a platform for creating, sending, and tracking email campaigns. It helps you automate marketing workflows and manage subscriber lists for better engagement.

## Frequently Asked Questions

### Do I need my own developer credentials to use Cardly with Composio?

Yes, Cardly requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)