Cardly

Learn how to use Cardly with Composio

Overview

Enum

CARDLY

Description

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

Authentication Details

api_key
stringRequired

Actions

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

Action Parameters

description
string
fields
array
name
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
Tool to create a new webhook subscription. use when you need cardly to notify your application via http post for specific events.

Action Parameters

description
string
events
arrayRequired
metadata
object
targetUrl
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
Tool to delete an invitation by email address. use when you need to invalidate an outstanding invitation immediately.

Action Parameters

email
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
Tool to delete a webhook. use after confirming the webhook id to immediately cease all activity and event subscriptions for that webhook.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
Tool to generate a low-quality, watermarked preview document for a card. use after confirming artwork and template details to estimate costs and delivery.

Action Parameters

artwork
stringRequired
messages
object
purchaseOrderNumber
string
recipient
objectRequired
requestedArrival
string
sender
object
shipToMe
boolean
shippingMethod
string
style
object
template
string
variables
object

Action Response

data
object
error
string
state
object
successful
boolean
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.

Action Parameters

limit
integer
offset
integer
ownOnly
boolean

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to list credit history records. use after checking account balance to review recent credits/debits.

Action Parameters

effectiveTime.gt
string
effectiveTime.gte
string
effectiveTime.lt
string
effectiveTime.lte
string
limit
integerDefaults to 25
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
Tool to list your currently available fonts. use after confirming authentication to explore font options in cardly.

Action Parameters

limit
integerDefaults to 25
offset
integer
organisationOnly
boolean

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to list gift credit history records for your organization. use when you need paginated gift credit entries with optional time-based filters.

Action Parameters

effectiveTime.gt
string
effectiveTime.gte
string
effectiveTime.lt
string
effectiveTime.lte
string
limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
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.

Action Parameters

acceptedOnly
boolean
expiredOnly
boolean
includeAccepted
boolean
limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve the currently available media sizes for product artwork. use when you need to explore or validate media options before creating artwork.

Action Parameters

limit
integer
offset
integer
organisationOnly
boolean

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve orders placed by your organisation. use when you need to fetch paginated order history after confirming the endpoint.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve your currently available templates from cardly. use to list and paginate templates for selection in card sends.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve all users associated with your account. use when you need to list and paginate user accounts.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve any active or disabled webhooks set up for your organisation. use when you need to audit configured webhook endpoints before modifying subscriptions.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to list available writing styles. use when you need to retrieve writing styles available for handwriting personalization.

Action Parameters

limit
integer
offset
integer

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve the current account and gift credit balances for your organisation. use after authenticating to verify available credit before placing orders.

Action Parameters

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve information on a specific order. use after obtaining an order id to fetch its details.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to retrieve detailed information about a specific user. use after obtaining the user id to fetch its details.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean
Tool to update a webhook’s settings, including target url and events. use after retrieving existing webhook to apply configuration changes.

Action Parameters

description
string
disabled
boolean
events
arrayRequired
id
stringRequired
metadata
object
targetUrl
stringRequired

Action Response

data
object
error
string
state
object
successful
boolean
testMode
boolean