- Category: marketing automation
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 29
- Triggers: 0
- Slug:
CARDLY - Version: 20261101_00
Tools
Create Contact List
Create Contact List
Create Invitation
Create Invitation
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
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
Create Webhook
Create Webhook
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
List of event names this webhook subscribes to; only notifications for these events will be sent.
The URL this webhook will send POST requests to once one of the subscribed events is triggered. Must be a valid HTTPS endpoint.
Output
Delete Invitation
Delete Invitation
Delete Invitation by Email
Delete Invitation by Email
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
The exact email address of the invitation to delete. Must match the email used when the invitation was created.
Output
Delete User
Delete User
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
The unique ID of the user to delete. This immediately revokes their access to your organisation portal. Cannot remove users with administrator privileges.
Output
Delete User by Email
Delete User by Email
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
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
Delete Webhook
Delete Webhook
Echo Request
Echo Request
Generate Preview
Generate Preview
Get Artwork
Get Artwork
Get Webhook
Get Webhook
List Artwork
List Artwork
List Contact Lists
List Contact Lists
List Credit History
List Credit History
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
Filter transactions after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
Filter transactions before this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
Filter transactions at or after this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-01 00:00:00’).
Filter transactions before or at this datetime. Format: YYYY-MM-DD HH:MM:SS (e.g., ‘2024-01-31 23:59:59’).
Output
List Doodles
List Doodles
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
If true, return only doodles that are exclusive to your organisation. Set to false (default) to see all available doodles.
Output
List Fonts
List Fonts
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
Maximum number of font records to return per page. Defaults to 25. Use lower values for faster responses or higher values to reduce pagination.
Number of font records to skip for pagination. Use 0 for the first page, then increment by limit for subsequent pages.
Filter to show only organization-exclusive custom fonts. Set to false (default) to see all available fonts including public ones.
Output
List Gift Credit History
List Gift Credit History
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
Maximum number of records to return per page. Must be at least 1. Defaults to 25 if not specified.
Number of records to skip before returning results (for pagination). Must be non-negative. Defaults to 0 if not specified.
Filter for records after this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-01-01 00:00:00’).
Filter for records before this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-12-31 23:59:59’).
Filter for records at or after this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-01-01 00:00:00’).
Filter for records before or at this time. Format: ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2024-12-31 23:59:59’).
Output
List Invitations
List Invitations
List Media
List Media
List Orders
List Orders
List Templates
List Templates
List Users
List Users
List Webhooks
List Webhooks
List Writing Styles
List Writing Styles
Retrieve Account Balance
Retrieve Account Balance
Retrieve Order
Retrieve Order
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
The unique UUID of the order to retrieve. Obtain this from the List Orders action or from order creation responses.
Output
Retrieve User
Retrieve User
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
The unique UUID identifier of the user to retrieve. Obtain this from the list_users action.
Output
Update Webhook
Update Webhook
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
List of event names this webhook subscribes to; only notifications for these events will be sent.
The URL this webhook will send POST requests to once one of its subscribed events is triggered.