# Cardly

Cardly helps businesses create great engagement with customers by getting out of inboxes and into mailboxes.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `CARDLY`
- **Version:** 20260217_00

## Tools

### Create Contact List

**Slug:** `CARDLY_CREATE_CONTACT_LIST`

Tool to add a new contact list. Use after defining name and optional custom fields, before populating the list with contacts.

### Create Invitation

**Slug:** `CARDLY_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.

### Create Webhook

**Slug:** `CARDLY_CREATE_WEBHOOK`

Tool to create a new webhook subscription. Use when you need Cardly to notify your application via HTTP POST for specific events.

### Delete Invitation

**Slug:** `CARDLY_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.

### Delete Invitation by Email

**Slug:** `CARDLY_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.

### Delete User

**Slug:** `CARDLY_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.

### Delete User by Email

**Slug:** `CARDLY_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.

### Delete Webhook

**Slug:** `CARDLY_DELETE_WEBHOOK`

Tool to delete a webhook. Use after confirming the webhook ID to immediately cease all activity and event subscriptions for that webhook.

### Echo Request

**Slug:** `CARDLY_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.

### Generate Preview

**Slug:** `CARDLY_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.

### Get Artwork

**Slug:** `CARDLY_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.

### Get Webhook

**Slug:** `CARDLY_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.

### List Artwork

**Slug:** `CARDLY_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.

### List Contact Lists

**Slug:** `CARDLY_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.

### List Credit History

**Slug:** `CARDLY_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.

### List Doodles

**Slug:** `CARDLY_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.

### List Fonts

**Slug:** `CARDLY_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.

### List Gift Credit History

**Slug:** `CARDLY_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.

### List Invitations

**Slug:** `CARDLY_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.

### List Media

**Slug:** `CARDLY_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.

### List Orders

**Slug:** `CARDLY_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.

### List Templates

**Slug:** `CARDLY_LIST_TEMPLATES`

Tool to retrieve your currently available templates from Cardly. Use to list and paginate templates for selection in card sends.

### List Users

**Slug:** `CARDLY_LIST_USERS`

Tool to retrieve all users associated with your account. Use when you need to list and paginate user accounts.

### List Webhooks

**Slug:** `CARDLY_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.

### List Writing Styles

**Slug:** `CARDLY_LIST_WRITING_STYLES`

Tool to list available writing styles. Use when you need to retrieve writing styles available for handwriting personalization.

### Retrieve Account Balance

**Slug:** `CARDLY_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.

### Retrieve Order

**Slug:** `CARDLY_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.

### Retrieve User

**Slug:** `CARDLY_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.

### Update Webhook

**Slug:** `CARDLY_UPDATE_WEBHOOK`

Tool to update a webhook’s settings, including target URL and events. Use after retrieving existing webhook to apply configuration changes.
