> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Cardly

The Cardly connector lets your AI agent act in each user's Cardly account. Each user connects their own Cardly API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 47 tools.

**Authentication:** API Key
**Categories:** Marketing, CRM & Sales
**Tools:** 47: 26 read, 12 write, 9 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CARDLY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Cardly connection

   In **AgentKit > Connections**, create a Cardly connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'cardly'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Cardly:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'cardly_account_balance_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "cardly"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Cardly:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="cardly_account_balance_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Cardly credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'cardly_account_balance_get',
  toolInput: {},
  connector: 'cardly',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="cardly_account_balance_get",
    tool_input={},
    connection_name="cardly",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `cardly_account_balance_get`

Get Account Balance · Read-only

Get the Cardly organisation's current credit and gift credit balance.
Returns the organisation's current balances.
Use List Credit History for the transactions behind it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_art_get`

Get Artwork · Read-only

Get one piece of artwork by ID.
Returns its name, description, media and pages.
Use List Artwork to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_art_list`

List Artwork · Read-only

List the card artwork available to the organisation, optionally only its own.
Returns artwork with id, slug, name, media size and page previews.
Use the id or slug in Generate Preview or Place Order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `own_only` (`boolean`, optional): If set to a truthy value, results will contain only artwork that belongs to your organisation and no shared or freely available artwork. Defaults to false, showing all artwork. Example: true.

Example input: `{}`

### `cardly_contact_find`

Find Contact · Read-only

Find a contact in a list by email address or external ID.
Returns the matching contact.
Use List Contacts to browse the list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
- `query` (`string`, required): An email address or external identifier to locate a contact by within the given list. Example: thor@avengers.com.

Example input: `{"list_id":"<list_id>","query":"<query>"}`

### `cardly_contact_get`

Get Contact · Read-only

Get one contact in a list by Cardly's contact ID.
Returns the contact's name, email, address and custom fields.
Use Find Contact to look up by email or external ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.

Example input: `{"id":"<id>","list_id":"<list_id>"}`

### `cardly_contact_list_get`

Get Contact List · Read-only

Get one contact list by ID.
Returns its name, description and custom fields.
Use List Contact Lists to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_contact_lists_list`

List Contact Lists · Read-only

List the organisation's active contact lists.
Returns lists with id, name, description and custom fields.
Use List Contacts for the contacts in a list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_contacts_list`

List Contacts · Read-only

List the active contacts in a contact list.
Returns contacts with id, external ID, name, email, address and custom fields.
Use Find Contact to look one up by email or external ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.

Example input: `{"list_id":"<list_id>"}`

### `cardly_credit_history_list`

List Credit History · Read-only

List the organisation's credit and debit records, optionally within a time range.
Returns each record with amount, balance, effective time and the reason or linked order.
Use List Gift Credit History for gift credits.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `effective_time_gt` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after* this time. Example: 2026-10-01 00:00:00.
- `effective_time_gte` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after or equal* to this time. Example: 2026-10-01 00:00:00.
- `effective_time_lt` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before* this time. Example: 2026-11-01 00:00:00.
- `effective_time_lte` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before or equal* to this time. Example: 2026-11-01 00:00:00.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.

Example input: `{}`

### `cardly_doodles_list`

List Doodles · Read-only

List the handwritten-style doodles available for card messages.
Returns doodles with id, name and preview.
Use List Fonts and List Writing Styles for other message options.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `organisation_only` (`boolean`, optional): If truthy, only return doodles that are exclusive to your organisation. Example: true.

Example input: `{}`

### `cardly_fonts_list`

List Fonts · Read-only

List the fonts available for card messages.
Returns fonts with id and name.
Use a font in an order's style.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `organisation_only` (`boolean`, optional): If truthy, only return fonts that are exclusive to your organisation. Example: true.

Example input: `{}`

### `cardly_gift_credit_history_list`

List Gift Credit History · Read-only

List the organisation's gift credit and debit records, optionally within a time range.
Returns each record with amount, balance, effective time and reason.
Use List Credit History for regular credits.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `effective_time_gt` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after* this time. Example: 2026-10-01 00:00:00.
- `effective_time_gte` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after or equal* to this time. Example: 2026-10-01 00:00:00.
- `effective_time_lt` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before* this time. Example: 2026-11-01 00:00:00.
- `effective_time_lte` (`string`, optional): `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before or equal* to this time. Example: 2026-11-01 00:00:00.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.

Example input: `{}`

### `cardly_invitation_find`

Find Invitation · Read-only

Find an invitation by email address.
Returns the matching invitation.
Use List Invitations to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): The email address to search for. Example: thor@avengers.com.

Example input: `{"email":"<email>"}`

### `cardly_invitation_get`

Get Invitation · Read-only

Get one invitation by ID.
Returns its email, permissions, status and expiry.
Use List Invitations to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_invitations_list`

List Invitations · Read-only

List invitations to the organisation portal, optionally accepted or expired ones.
Returns invitations with id, email, permissions and status.
Use Find Invitation to look one up by email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `accepted_only` (`boolean`, optional): If truthy, only return accepted invitations. Example: true.
- `expired_only` (`boolean`, optional): If truthy, only return expired invitations. Example: true.
- `include_accepted` (`boolean`, optional): If truthy, includes accepted invitations in the response. By default, accepted invitations are filtered out of listings. Example: true.
- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.

Example input: `{}`

### `cardly_media_list`

List Media · Read-only

List the card media sizes (formats) available for artwork.
Returns media with id, name, dimensions and page count.
Use a media ID in Create Artwork.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 25.
- `offset` (`integer`, optional): Number of records to skip, for paging. Example: 0.
- `organisation_only` (`boolean`, optional): If truthy, only return media items that are exclusive to your organisation. Example: true.

Example input: `{}`

### `cardly_order_get`

Get Order · Read-only

Get one order by ID.
Returns its status, cost, and each line's artwork, recipient, shipping and tracking.
Use List Orders to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_order_preview`

Generate Preview · Read-only

Generate a low-quality watermarked preview PDF of a card from artwork, template, message and recipient.
Returns preview URLs and the price and estimated delivery.
Use Place Order to send the card. Places no order and charges nothing.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `artwork` (`string`, required): Artwork UUID or slug for the card. Get it from List Artwork. Example: happy-birthday.
- `recipient` (`object`, required): Envelope address of the recipient: firstName, lastName, company, address, address2, city, region, postcode and country (2-letter ISO). firstName, address, city, region, postcode and country are required. Example: {"firstName": "Thor", "lastName": "Odinson", "address": "1 Main Street", "city": "Brooklyn", "region": "NY", "postcode": "11201", "country": "US"}.
- `messages` (`object`, optional): Text for the card's pages when not using a template: a pages list, each with page number, text and an optional style. Example: {"pages": [{"page": 2, "text": "Happy birthday, Thor!"}]}.
- `purchase_order_number` (`string`, optional): A purchase order or other identifier to store against the order. Note that this has no bearing on a preview, unless there is an template variable that accepts this value. Example: PO1234.
- `requested_arrival` (`string`, optional): A future requested arrival date for this card. In a preview request, this will provide a basis for shipping window estimates to be returned. If not specified, immediate dispatch is assumed and dates will be calculated based on the current date. Example: 2024-12-25.
- `sender` (`object`, optional): Optional sender details printed as the return address, with the same fields as recipient; omitAddress hides the address. Example: {"firstName": "Bruce", "lastName": "Banner", "company": "Avengers Inc", "address": "1 Main Street", "city": "Brooklyn", "region": "NY", "postcode": "11201", "country": "US"}.
- `ship_to_me` (`boolean`, optional): If set to `true`, denotes that the recipient of this card is also the sender and to include an additional, blank envelope. Note that this incurs a small additional credit cost per card within the order. Example: false.
- `shipping_method` (`string`, optional): The shipping method to use. Note that shipping method support is on a per-region basis, but all regions will at minimum support the standard shipping method. Currently, only Australia supports the `tracked` shipping method. Currently, only Australia and the United States support the `express` shipping method. Example: standard. One of: `standard`, `tracked`, `express`.
- `style` (`object`, optional): Default text style for the whole card, for example color, font, size or alignment. Example: {"color": "1144a7"}.
- `template` (`string`, optional): The template ID to use top populate this card. If no template is specified, only the main text panels on the card will be utilised and no variable substitutions will occur. Example: happy-birthday-promo.
- `variables` (`object`, optional): Zero or more variables to inject into a template, based on the variables supported by that template. This is a key => value mapped object based on the variables to use in the template. Example: {"firstName": "Thor", "company": "Avengers Inc."}.

Example input: `{"artwork":"<artwork>","recipient":{"firstName":"Thor","lastName":"Odinson","address":"1 Main Street","city":"Brooklyn","region":"NY","postcode":"11201","country":"US"}}`

### `cardly_orders_list`

List Orders · Read-only

List orders placed by the organisation.
Returns orders with id, status, cost, lines and timestamps.
Use Get Order for one order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_templates_list`

List Templates · Read-only

List the message templates available to the organisation.
Returns templates with id, name, artwork and the variables each supports.
Use a template and its variables in Generate Preview or Place Order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_user_find`

Find User · Read-only

Find a portal user by email address.
Returns the matching user.
Use List Users to browse.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): The email address to search for. Example: thor@avengers.com.

Example input: `{"email":"<email>"}`

### `cardly_user_get`

Get User · Read-only

Get one portal user by ID.
Returns the user's name, email and permissions.
Use List Users to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_users_list`

List Users · Read-only

List the active users of the organisation portal.
Returns users with id, name, email and permissions.
Use Find User to look one up by email.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_webhook_get`

Get Webhook · Read-only

Get one webhook by ID.
Returns its target URL, events, status and metadata.
Use List Webhooks to find IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_webhooks_list`

List Webhooks · Read-only

List the organisation's active and disabled webhooks.
Returns webhooks with id, target URL, events and status.
Use Get Webhook for one webhook.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_writing_styles_list`

List Writing Styles · Read-only

List the handwriting styles available for card messages.
Returns writing styles with id and name.
Use a writing style in an order's style.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `cardly_art_create`

Create Artwork · Write

Upload new card artwork with base64 page images on a given media size.
Returns the new artwork with its id.
Use List Media for media IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `artwork` (`array`, required): Pages and their images to attach, each with a page number and a base64-encoded image. Example: [{"page": 1, "image": "iVBORw0KGg..."}, {"page": 3, "image": "iVBORw0KGg..."}].
- `media` (`string`, required): UUID for the media this artwork will use. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `name` (`string`, required): A short description for this artwork. Example: API Artwork Upload.
- `description` (`string`, optional): A longer human-readable description of the artwork. Example: Testing adding a 4p card via API call..

Example input: `{"artwork":[{"page":1,"image":"iVBORw0KGg..."},{"page":3,"image":"iVBORw0KGg..."}],"media":"<media>","name":"<name>"}`

### `cardly_art_update`

Update Artwork · Write

Update an artwork's name, description or page images. Only fields you send change.
Returns the updated artwork.
Use Get Artwork to read the current values.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `artwork` (`array`, optional): Pages and their images to replace, each with a page number and a base64-encoded image. Example: [{"page": 1, "image": "iVBORw0KGg..."}, {"page": 3, "image": "iVBORw0KGg..."}].
- `description` (`string`, optional): A longer human-readable description of the artwork. Example: Testing updating a 4p card via API call..
- `name` (`string`, optional): A short description for this artwork. Example: API Artwork Update.

Example input: `{"id":"<id>"}`

### `cardly_contact_create`

Create Contact · Write

Add a contact with a mailing address to a contact list.
Returns the new contact. Contacts are unique by external ID and email within the list.
Use Sync Contact to create or update in one call.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address` (`string`, required): The primary address line, including street number, name and type. Example: 1 Main Street.
- `country` (`string`, required): A 2-character ISO code identifying the contact's country. Example: US.
- `first_name` (`string`, required): The first name of a contact. Example: Thor.
- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
- `locality` (`string`, required): A suburb or city for the contact. Example: Brooklyn.
- `postcode` (`string`, required): A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
- `region` (`string`, required): The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
- `address2` (`string`, optional): A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
- `company` (`string`, optional): The company a contact belongs to, if required. Example: Avengers Inc..
- `email` (`string`, optional): An email address for this contact, if supplied, which can be used to uniquely identify this contact for subsequent actions. Example: thor@avengers.com.
- `external_id` (`string`, optional): Any external identifier you have supplied for this contact which can be used to update this contact in future calls. Example: thor1234.
- `fields` (`object`, optional): Custom field values keyed by the list's field codes. Example: {"birthday": "1052-04-01T00:00:00.000Z", "homepage": "https://www.avengers.com/profile/thor"}.
- `last_name` (`string`, optional): The last name of a contact, if known / applicable. Example: Odinson.

Example input: `{"address":"<address>","country":"<country>","first_name":"<first_name>","list_id":"<list_id>","locality":"<locality>","postcode":"<postcode>","region":"<region>"}`

### `cardly_contact_list_create`

Create Contact List · Write

Create a contact list, optionally with custom fields such as a birthday.
Returns the new list with its id.
Use Create Contact or Sync Contact to add contacts.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): A short description for this contact list to allow it to be identified. Example: Employee Birthdays.
- `description` (`string`, optional): A free-text description of this list to store whatever additional information might be necesssary. Example: Current employee birthdays for all staff..
- `fields` (`array`, optional): Custom fields to add to the list, each with a name and type (for example date or text). Example: [{"name": "Birthday", "type": "date", "image": "iVBORw0KGg..."}, {"name": "Preferred Name", "type": "text", "description": "The customer's preferred name when we address them."}].

Example input: `{"name":"<name>"}`

### `cardly_contact_sync`

Sync Contact · Write

Create or update a contact in a list, matched by external ID or email.
Returns the created or updated contact.
Use it to keep a CRM in step with Cardly lists.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address` (`string`, required): The primary address line, including street number, name and type. Example: 1 Main Street.
- `country` (`string`, required): A 2-character ISO code identifying the contact's country. Example: US.
- `first_name` (`string`, required): The first name of a contact. Example: Thor.
- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
- `locality` (`string`, required): A suburb or city for the contact. Example: Brooklyn.
- `postcode` (`string`, required): A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
- `region` (`string`, required): The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
- `address2` (`string`, optional): A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
- `company` (`string`, optional): The company a contact belongs to, if required. Example: Avengers Inc..
- `email` (`string`, optional): An email address for this contact, if supplied, which can be used to uniquely identify this contact for subsequent actions. **Conditionally required:** At least one of `externalId` or `email` is required for a sync operation. Example: thor@avengers.com.
- `external_id` (`string`, optional): Any external identifier you have supplied for this contact which can be used to update this contact in future calls. **Conditionally required:** At least one of `externalId` or `email` is required for a sync operation. Example: thor1234.
- `fields` (`object`, optional): Custom field values keyed by the list's field codes. Example: {"birthday": "1052-04-01T00:00:00.000Z", "homepage": "https://www.avengers.com/profile/thor"}.
- `last_name` (`string`, optional): The last name of a contact, if known / applicable. Example: Odinson.

Example input: `{"address":"<address>","country":"<country>","first_name":"<first_name>","list_id":"<list_id>","locality":"<locality>","postcode":"<postcode>","region":"<region>"}`

### `cardly_contact_update`

Update Contact · Write

Update a contact's details and address.
Returns the updated contact.
Use Sync Contact to update by external ID or email instead.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `address` (`string`, required): The primary address line, including street number, name and type. Example: 1 Main Street.
- `country` (`string`, required): A 2-character ISO code identifying the contact's country. Example: US.
- `first_name` (`string`, required): The first name of a contact. Example: Thor.
- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
- `locality` (`string`, required): A suburb or city for the contact. Example: Brooklyn.
- `postcode` (`string`, required): A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
- `region` (`string`, required): The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
- `address2` (`string`, optional): A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
- `company` (`string`, optional): The company a contact belongs to, if required. Example: Avengers Inc..
- `email` (`string`, optional): An email address for this contact, if supplied, which can be used to uniquely identify this contact for subsequent actions. Example: thor@avengers.com.
- `external_id` (`string`, optional): Any external identifier you have supplied for this contact which can be used to update this contact in future calls. Example: thor1234.
- `fields` (`object`, optional): Custom field values keyed by the list's field codes. Example: {"birthday": "1052-04-01T00:00:00.000Z", "homepage": "https://www.avengers.com/profile/thor"}.
- `last_name` (`string`, optional): The last name of a contact, if known / applicable. Example: Odinson.

Example input: `{"address":"<address>","country":"<country>","first_name":"<first_name>","id":"<id>","list_id":"<list_id>","locality":"<locality>","postcode":"<postcode>","region":"<region>"}`

### `cardly_invitation_create`

Create Invitation · Write

Invite someone by email to the organisation portal, with chosen permissions.
Returns the invitation. Sends an email to the invitee.
Use Resend Invitation to send it again.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): An email address for this user. Example: thor@avengers.com.
- `first_name` (`string`, optional): The first name of the user. Example: Thor.
- `last_name` (`string`, optional): The last name of the user. Example: Odinson.
- `permissions` (`array`, optional): Permissions to grant the invited user: administrator, artwork, billing, campaigns, developer, lists, moderate, moderate-history, orders, templates, users, use-credits or use-saved-card. Example: ["orders", "use-credits"].

Example input: `{"email":"<email>"}`

### `cardly_invitation_resend`

Resend Invitation · Write

Resend a pending invitation by ID.
Returns a confirmation. Sends the email again.
Use Resend Invitation by Email when you only know the address.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_invitation_resend_by_email`

Resend Invitation by Email · Write

Resend a pending invitation to an email address.
Returns a confirmation. Sends the email again.
Use Resend Invitation when you have the invitation ID.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, optional): The email address to search for. Example: thor@avengers.com.

Example input: `{}`

### `cardly_order_place`

Place Order · Write

Order one or more physical cards to be printed and mailed, charging the organisation's credit.
Returns the order with its id, lines and cost. A test key validates without placing an order.
Use Generate Preview first to check the card.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `lines` (`array`, required): Order items. Each item has artwork (UUID or slug), optional template, quantity, messages, variables, style, recipient, sender, shippingMethod (standard, tracked or express), shipToMe and requestedArrival (YYYY-MM-DD). Example: [{"artwork": "happy-birthday", "template": "happy-birthday-promo", "recipient": {"firstName": "Thor", "lastName": "Odinson", "address": "1 Main Street", "city": "Brooklyn", "region": "NY", "postcode": "11201", "country": "US"}, "shippingMethod": "standard"}].
- `purchase_order_number` (`string`, optional): A reference number to place against this order - useful to tie back to your existing systems for auditing. Example: PO1234.

Example input: `{"lines":[{"artwork":"happy-birthday","template":"happy-birthday-promo","recipient":{"firstName":"Thor","lastName":"Odinson","address":"1 Main Street","city":"Brooklyn","region":"NY","postcode":"11201","country":"US"},"shippingMethod":"standard"}]}`

### `cardly_webhook_create`

Create Webhook · Write

Create a webhook that posts Cardly events (such as order created or sent) to your URL.
Returns the new webhook with its id.
Use List Webhooks to see existing ones.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `events` (`array`, required): Events the webhook is subscribed to, for example contact.order.created or contact.order.sent. Example: ["contact.order.created", "contact.order.sent", "contact.undeliverable", "contact.changeOfAddress"].
- `target_url` (`string`, required): The URL this webhook will send POST requests to once one of its subscribed events is triggered. Example: https://www.stark-industries.com/postbacks/inbound.
- `description` (`string`, optional): A free text description of what this webhook is for, or any notes related to the webhook. Example: Aid with feeding send data and change-of-address information back into our CRM..
- `metadata` (`object`, optional): Key-value pairs to store on the webhook. Example: {"source": "crm"}.

Example input: `{"events":["contact.order.created","contact.order.sent","contact.undeliverable","contact.changeOfAddress"],"target_url":"<target_url>"}`

### `cardly_webhook_update`

Update Webhook · Write

Update a webhook's target URL, events, description, metadata or disabled flag.
Returns the updated webhook. Changes apply immediately.
Use Get Webhook to read the current values.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `target_url` (`string`, required): The URL this webhook will send POST requests to once one of its subscribed events is triggered. Example: https://www.stark-industries.com/postbacks/inbound.
- `description` (`string`, optional): A free text description of what this webhook is for, or any notes related to the webhook. Example: Aid with feeding send data and change-of-address information back into our CRM..
- `disabled` (`boolean`, optional): If supplied and truthy, disables the webhook. If supplied and falsey, enables it instead. Example: true.
- `events` (`array`, optional): Events the webhook is subscribed to, for example contact.order.created or contact.order.sent. Example: ["contact.order.created", "contact.order.sent", "contact.undeliverable", "contact.changeOfAddress"].
- `metadata` (`object`, optional): Key-value pairs to store on the webhook. Example: {"source": "crm"}.

Example input: `{"id":"<id>","target_url":"<target_url>"}`

### `cardly_art_delete`

Delete Artwork · Destructive

Delete a piece of artwork the organisation owns.
Returns a confirmation.
Use List Artwork with own_only to find its ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_contact_delete`

Delete Contact · Destructive

Delete a contact by Cardly's contact ID, disabling linked automations.
Returns a confirmation.
Use Delete Contact by Email or External ID when you lack the ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.

Example input: `{"id":"<id>","list_id":"<list_id>"}`

### `cardly_contact_delete_by_match`

Delete Contact by Email or External ID · Destructive

Delete a contact from a list, matched by external ID or email.
Returns a confirmation; linked automations stop for the contact.
Use Delete Contact when you have Cardly's contact ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `list_id` (`string`, required): Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
- `email` (`string`, optional): An email address to identify the contact to delete, if no external ID is supplied. Example: thor@avengers.com.
- `external_id` (`string`, optional): Any external identifier to identify the contact to delete, if no email address is supplied. Example: thor1234.

Example input: `{"list_id":"<list_id>"}`

### `cardly_contact_list_delete`

Delete Contact List · Destructive

Delete a contact list and disable any automations linked to it.
Returns a confirmation.
Use List Contact Lists to find the ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_invitation_delete`

Delete Invitation · Destructive

Revoke a pending invitation by ID.
Returns a confirmation.
Use Delete Invitation by Email when you only know the address.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_invitation_delete_by_email`

Delete Invitation by Email · Destructive

Revoke a pending invitation by email address.
Returns a confirmation.
Use Delete Invitation when you have the invitation ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): The email address to search for. Example: thor@avengers.com.

Example input: `{}`

### `cardly_user_delete`

Delete User · Destructive

Revoke a user's portal access by ID. Admin users cannot be removed.
Returns a confirmation.
Use Delete User by Email when you only know the address.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

### `cardly_user_delete_by_email`

Delete User by Email · Destructive

Revoke a user's portal access by email address. Admin users cannot be removed.
Returns a confirmation.
Use Delete User when you have the user ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, optional): The email address to search for. Example: thor@avengers.com.

Example input: `{}`

### `cardly_webhook_delete`

Delete Webhook · Destructive

Delete a webhook and stop all its deliveries.
Returns a confirmation.
Use Update Webhook with disabled to pause it instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.

Example input: `{"id":"<id>"}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
