Skip to main content
Cardly logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: CARDLY
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
A short, unique name for this contact list.
array
Custom fields to add to this list. New fields will be created; existing fields (matched by name) updated.
string
Free-text description of this contact list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_CREATE_INVITATIONTool 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.

Input Parameters

string
required
An email address for the user to invite. Required.
string
The last name of the user being invited.
string
The first name of the user being invited.
array
Zero or more permission identifiers denoting the privileges to grant the user once they accept your invitation. If omitted, the user will have default permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_CREATE_WEBHOOKCreates a Cardly webhook subscription to send HTTP POST notifications to a specified HTTPS endpoint when subscribed events occur. An optional description and metadata can be attached to the webhook.

Input Parameters

array
required
List of event names this webhook subscribes to; only notifications for these events will be sent.
object
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
string
required
The URL this webhook will send POST requests to once one of the subscribed events is triggered. Must be a valid HTTPS endpoint.
string
Free-text description of what this webhook is for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_DELETE_INVITATIONTool to delete an invitation by unique ID, immediately invalidating it for acceptance. Use when you need to revoke a pending invitation using its ID.

Input Parameters

string
required
The unique ID of the invitation to revoke.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_DELETE_INVITATION_BY_EMAILDeletes 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.

Input Parameters

string
required
The exact email address of the invitation to delete. Must match the email used when the invitation was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_DELETE_USERTool 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.

Input Parameters

string
required
The unique ID of the user to delete. This immediately revokes their access to your organisation portal. Cannot remove users with administrator privileges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_DELETE_USER_BY_EMAILDeletes 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.

Input Parameters

string
required
The email address of the user to delete. This will immediately revoke their access to your organisation portal. Cannot remove users with administrator privileges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_DELETE_WEBHOOKTool to delete a webhook. Use after confirming the webhook ID to immediately cease all activity and event subscriptions for that webhook.

Input Parameters

string
required
The unique ID of the webhook to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_ECHO_REQUESTTool to echo all request parameters, body, and headers for debugging purposes. Use when validating authentication or testing API connectivity without affecting account data.

Input Parameters

array
A body parameter which will be returned to you in the response.
string
A body parameter which will be returned to you in the response.
string
An example query parameter which will be returned to you in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_GENERATE_PREVIEWTool to generate a low-quality, watermarked preview document for a card. Use after confirming artwork and template details to estimate costs and delivery.

Input Parameters

object
Global style overrides (optional)
object
Sender details (provide all fields if specifying)
string
required
Artwork UUID to preview (obtain from LIST_ARTWORK action)
object
Message overrides when not using a template
boolean
True to send a blank envelope back to sender
string
Template ID for variable substitution (optional)
object
required
Envelope recipient details
object
Key/value map of template variables to inject
string ("standard" | "tracked" | "express")
Shipping method (per-region support varies)
string
Desired arrival date (ISO 8601) for estimates
string
Reference number for internal tracking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_GET_ARTWORKTool 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.

Input Parameters

string
required
The unique ID of the artwork you wish to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_GET_WEBHOOKTool 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.

Input Parameters

string
required
The unique ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_ARTWORKTool 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.

Input Parameters

integer
Maximum number of artwork items to return
integer
Number of records to skip before returning results
boolean
If true, return only artwork owned by your organisation; defaults to false

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_CONTACT_LISTSTool 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.

Input Parameters

integer
Maximum number of contact lists to return. Defaults to API default if omitted.
integer
Number of records to skip before returning results. Defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_CREDIT_HISTORYRetrieves 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.

Input Parameters

integer
Maximum number of records to retrieve per page, must be at least 1.
integer
Number of records to skip before starting to collect the result set, must be non-negative.
string
Filter transactions after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
string
Filter transactions before this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
string
Filter transactions at or after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
string
Filter transactions before or at this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-31 23:59:59’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_DOODLESRetrieve your currently available doodles from Cardly. Returns doodle metadata including name and restriction status. Use this to discover available doodle designs before creating cards.

Input Parameters

boolean
If true, return only doodles that are exclusive to your organisation. Set to false (default) to see all available doodles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_FONTSList 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.

Input Parameters

integer
Maximum number of font records to return per page. Defaults to 25. Use lower values for faster responses or higher values to reduce pagination.
integer
Number of font records to skip for pagination. Use 0 for the first page, then increment by limit for subsequent pages.
boolean
Filter to show only organization-exclusive custom fonts. Set to false (default) to see all available fonts including public ones.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_GIFT_CREDIT_HISTORYLists 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.

Input Parameters

integer
Maximum number of records to return per page. Must be at least 1. Defaults to 25 if not specified.
integer
Number of records to skip before returning results (for pagination). Must be non-negative. Defaults to 0 if not specified.
string
Filter for records after this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-01-01 00:00:00’).
string
Filter for records before this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-12-31 23:59:59’).
string
Filter for records at or after this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-01-01 00:00:00’).
string
Filter for records before or at this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-12-31 23:59:59’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_INVITATIONSRetrieve invitations for your organisation with optional status filters and pagination. Use this to audit invited users and their statuses before sending new invitations or revoking access.

Input Parameters

integer
Maximum number of invitations to return. Defaults to API default if omitted.
integer
Number of invitation records to skip before returning results. Defaults to 0 if omitted.
boolean
If true, only return expired invitations.
boolean
If true, only return accepted invitations.
boolean
If true, includes accepted invitations in the response. Default filters them out.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_MEDIATool to retrieve the currently available media sizes for product artwork. Use when you need to explore or validate media options before creating artwork.

Input Parameters

integer
Maximum number of media items to return, defaults to 25 if omitted.
integer
Number of records to skip for pagination, defaults to 0 if omitted.
boolean
If true, only return media items exclusive to your organisation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_ORDERSRetrieves 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.

Input Parameters

integer
Maximum number of orders to return. Defaults to API default if omitted.
integer
Number of records to skip before returning results. Defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_TEMPLATESTool to retrieve your currently available templates from Cardly. Use to list and paginate templates for selection in card sends.

Input Parameters

integer
Maximum number of templates to return. Defaults to API default if omitted.
integer
Number of records to skip before returning results. Defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_USERSTool to retrieve all users associated with your account. Use when you need to list and paginate user accounts.

Input Parameters

integer
Maximum number of users to return. Defaults to API default if omitted.
integer
Number of user records to skip before returning results. Defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_WEBHOOKSLists webhooks configured for your organization in pages, including their status, target URLs, subscribed events, and available delivery statistics. Use limit and offset to retrieve additional pages.

Input Parameters

integer
Maximum number of webhooks to return. Defaults to API default if omitted.
integer
Number of webhook records to skip before returning results. Defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_LIST_WRITING_STYLESTool to list available writing styles. Use when you need to retrieve writing styles available for handwriting personalization.

Input Parameters

integer
Number of records to return, defaults to 25 if omitted.
integer
Number of records to skip for pagination, defaults to 0 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_RETRIEVE_ACCOUNT_BALANCETool to retrieve the current account and gift credit balances for your organisation. Use after authenticating to verify available credit before placing orders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_RETRIEVE_ORDERRetrieves 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.

Input Parameters

string
required
The unique UUID of the order to retrieve. Obtain this from the List Orders action or from order creation responses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_RETRIEVE_USERRetrieves 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.

Input Parameters

string
required
The unique UUID identifier of the user to retrieve. Obtain this from the list_users action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARDLY_UPDATE_WEBHOOKUpdates a webhook’s settings by ID, including its target URL and subscribed events. Both the target URL and events must be supplied, even when changing other settings.

Input Parameters

string
required
The unique ID of the webhook to update.
array
required
List of event names this webhook subscribes to; only notifications for these events will be sent.
boolean
If true, disables the webhook; if false, enables it.
object
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
string
required
The URL this webhook will send POST requests to once one of its subscribed events is triggered.
string
Free-text description of what this webhook is for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not