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.
- Tools
- 47
- What they doRead · write · destructive
- 26 · 12 · 926 read12 write9 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Cardly connection
In AgentKit > Connections, create a Cardly connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'cardly'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'cardly_account_balance_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "cardly"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="cardly_account_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Cardly credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcardly_account_balance_getGet the Cardly organisation's current credit and gift credit balance.Read-onlyGet Account Balance
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.
Inputs
This tool takes no inputs.
cardly_art_getGet one piece of artwork by ID.Read-onlyGet Artwork
Get one piece of artwork by ID. Returns its name, description, media and pages. Use List Artwork to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_art_listList the card artwork available to the organisation, optionally only its own.Read-onlyList Artwork
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.
Inputs
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
own_onlyboolean- 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.
cardly_contact_findFind a contact in a list by email address or external ID.Read-onlyFind Contact
Find a contact in a list by email address or external ID. Returns the matching contact. Use List Contacts to browse the list.
Inputs
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
querystringrequired- An email address or external identifier to locate a contact by within the given list. Example: thor@avengers.com.
cardly_contact_getGet one contact in a list by Cardly's contact ID.Read-onlyGet Contact
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.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
cardly_contact_list_getGet one contact list by ID.Read-onlyGet Contact List
Get one contact list by ID. Returns its name, description and custom fields. Use List Contact Lists to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_contact_lists_listList the organisation's active contact lists.Read-onlyList Contact Lists
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.
Inputs
This tool takes no inputs.
cardly_contacts_listList the active contacts in a contact list.Read-onlyList Contacts
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.
Inputs
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
cardly_credit_history_listList the organisation's credit and debit records, optionally within a time range.Read-onlyList Credit History
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.
Inputs
effective_time_gtstring- `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after* this time. Example: 2026-10-01 00:00:00.
effective_time_gtestring- `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_ltstring- `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before* this time. Example: 2026-11-01 00:00:00.
effective_time_ltestring- `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.
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
cardly_doodles_listList the handwritten-style doodles available for card messages.Read-onlyList Doodles
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.
Inputs
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
organisation_onlyboolean- If truthy, only return doodles that are exclusive to your organisation. Example: true.
cardly_fonts_listList the fonts available for card messages.Read-onlyList Fonts
List the fonts available for card messages. Returns fonts with id and name. Use a font in an order's style.
Inputs
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
organisation_onlyboolean- If truthy, only return fonts that are exclusive to your organisation. Example: true.
cardly_gift_credit_history_listList the organisation's gift credit and debit records, optionally within a time range.Read-onlyList Gift Credit History
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.
Inputs
effective_time_gtstring- `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *after* this time. Example: 2026-10-01 00:00:00.
effective_time_gtestring- `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_ltstring- `YYYY-MM-DD HH:ii:ss` formatted string to retrieve only results *before* this time. Example: 2026-11-01 00:00:00.
effective_time_ltestring- `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.
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
cardly_invitation_findFind an invitation by email address.Read-onlyFind Invitation
Find an invitation by email address. Returns the matching invitation. Use List Invitations to browse.
Inputs
emailstringrequired- The email address to search for. Example: thor@avengers.com.
cardly_invitation_getGet one invitation by ID.Read-onlyGet Invitation
Get one invitation by ID. Returns its email, permissions, status and expiry. Use List Invitations to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_invitations_listList invitations to the organisation portal, optionally accepted or expired ones.Read-onlyList Invitations
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.
Inputs
accepted_onlyboolean- If truthy, only return accepted invitations. Example: true.
expired_onlyboolean- If truthy, only return expired invitations. Example: true.
include_acceptedboolean- If truthy, includes accepted invitations in the response. By default, accepted invitations are filtered out of listings. Example: true.
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
cardly_media_listList the card media sizes (formats) available for artwork.Read-onlyList Media
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.
Inputs
limitinteger- Maximum number of records to return. Example: 25.
offsetinteger- Number of records to skip, for paging. Example: 0.
organisation_onlyboolean- If truthy, only return media items that are exclusive to your organisation. Example: true.
cardly_order_getGet one order by ID.Read-onlyGet Order
Get one order by ID. Returns its status, cost, and each line's artwork, recipient, shipping and tracking. Use List Orders to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_order_previewGenerate a low-quality watermarked preview PDF of a card from artwork, template, message and recipient.Read-onlyGenerate Preview
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.
Inputs
artworkstringrequired- Artwork UUID or slug for the card. Get it from List Artwork. Example: happy-birthday.
recipientobjectrequired- 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"}.
messagesobject- 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_numberstring- 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_arrivalstring- 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.
senderobject- 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_meboolean- 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_methodstring- 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
standardtrackedexpress styleobject- Default text style for the whole card, for example color, font, size or alignment. Example: {"color": "1144a7"}.
templatestring- 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.
variablesobject- 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."}.
cardly_orders_listList orders placed by the organisation.Read-onlyList Orders
List orders placed by the organisation. Returns orders with id, status, cost, lines and timestamps. Use Get Order for one order.
Inputs
This tool takes no inputs.
cardly_templates_listList the message templates available to the organisation.Read-onlyList Templates
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.
Inputs
This tool takes no inputs.
cardly_user_findFind a portal user by email address.Read-onlyFind User
Find a portal user by email address. Returns the matching user. Use List Users to browse.
Inputs
emailstringrequired- The email address to search for. Example: thor@avengers.com.
cardly_user_getGet one portal user by ID.Read-onlyGet User
Get one portal user by ID. Returns the user's name, email and permissions. Use List Users to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_users_listList the active users of the organisation portal.Read-onlyList Users
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.
Inputs
This tool takes no inputs.
cardly_webhook_getGet one webhook by ID.Read-onlyGet Webhook
Get one webhook by ID. Returns its target URL, events, status and metadata. Use List Webhooks to find IDs.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_webhooks_listList the organisation's active and disabled webhooks.Read-onlyList Webhooks
List the organisation's active and disabled webhooks. Returns webhooks with id, target URL, events and status. Use Get Webhook for one webhook.
Inputs
This tool takes no inputs.
cardly_writing_styles_listList the handwriting styles available for card messages.Read-onlyList Writing Styles
List the handwriting styles available for card messages. Returns writing styles with id and name. Use a writing style in an order's style.
Inputs
This tool takes no inputs.
cardly_art_createUpload new card artwork with base64 page images on a given media size.WriteCreate Artwork
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.
Inputs
artworkarrayrequired- 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..."}].
mediastringrequired- UUID for the media this artwork will use. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
namestringrequired- A short description for this artwork. Example: API Artwork Upload.
descriptionstring- A longer human-readable description of the artwork. Example: Testing adding a 4p card via API call..
cardly_art_updateUpdate an artwork's name, description or page images.WriteUpdate Artwork
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.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
artworkarray- 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..."}].
descriptionstring- A longer human-readable description of the artwork. Example: Testing updating a 4p card via API call..
namestring- A short description for this artwork. Example: API Artwork Update.
cardly_contact_createAdd a contact with a mailing address to a contact list.WriteCreate Contact
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.
Inputs
addressstringrequired- The primary address line, including street number, name and type. Example: 1 Main Street.
countrystringrequired- A 2-character ISO code identifying the contact's country. Example: US.
first_namestringrequired- The first name of a contact. Example: Thor.
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
localitystringrequired- A suburb or city for the contact. Example: Brooklyn.
postcodestringrequired- A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
regionstringrequired- The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
address2string- A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
companystring- The company a contact belongs to, if required. Example: Avengers Inc..
emailstring- 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_idstring- Any external identifier you have supplied for this contact which can be used to update this contact in future calls. Example: thor1234.
fieldsobject- 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_namestring- The last name of a contact, if known / applicable. Example: Odinson.
cardly_contact_list_createCreate a contact list, optionally with custom fields such as a birthday.WriteCreate Contact List
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.
Inputs
namestringrequired- A short description for this contact list to allow it to be identified. Example: Employee Birthdays.
descriptionstring- A free-text description of this list to store whatever additional information might be necesssary. Example: Current employee birthdays for all staff..
fieldsarray- 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."}].
cardly_contact_syncCreate or update a contact in a list, matched by external ID or email.WriteSync Contact
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.
- Idempotent
Inputs
addressstringrequired- The primary address line, including street number, name and type. Example: 1 Main Street.
countrystringrequired- A 2-character ISO code identifying the contact's country. Example: US.
first_namestringrequired- The first name of a contact. Example: Thor.
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
localitystringrequired- A suburb or city for the contact. Example: Brooklyn.
postcodestringrequired- A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
regionstringrequired- The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
address2string- A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
companystring- The company a contact belongs to, if required. Example: Avengers Inc..
emailstring- 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_idstring- 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.
fieldsobject- 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_namestring- The last name of a contact, if known / applicable. Example: Odinson.
cardly_contact_updateUpdate a contact's details and address.WriteUpdate Contact
Update a contact's details and address. Returns the updated contact. Use Sync Contact to update by external ID or email instead.
- Idempotent
Inputs
addressstringrequired- The primary address line, including street number, name and type. Example: 1 Main Street.
countrystringrequired- A 2-character ISO code identifying the contact's country. Example: US.
first_namestringrequired- The first name of a contact. Example: Thor.
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
localitystringrequired- A suburb or city for the contact. Example: Brooklyn.
postcodestringrequired- A postal code or ZIP code for this contact, where required by local addressing formats. **Conditionally required** based on the country supplied. Example: 11201.
regionstringrequired- The state or province for this address. **Conditionally required** based on the country supplied. Example: NY.
address2string- A secondary address line, typically containing a unit, apartment, suite number etc. Example: Suite 1451.
companystring- The company a contact belongs to, if required. Example: Avengers Inc..
emailstring- 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_idstring- Any external identifier you have supplied for this contact which can be used to update this contact in future calls. Example: thor1234.
fieldsobject- 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_namestring- The last name of a contact, if known / applicable. Example: Odinson.
cardly_invitation_createInvite someone by email to the organisation portal, with chosen permissions.WriteCreate Invitation
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.
Inputs
emailstringrequired- An email address for this user. Example: thor@avengers.com.
first_namestring- The first name of the user. Example: Thor.
last_namestring- The last name of the user. Example: Odinson.
permissionsarray- 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"].
cardly_invitation_resendResend a pending invitation by ID.WriteResend Invitation
Resend a pending invitation by ID. Returns a confirmation. Sends the email again. Use Resend Invitation by Email when you only know the address.
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_invitation_resend_by_emailResend a pending invitation to an email address.WriteResend Invitation by Email
Resend a pending invitation to an email address. Returns a confirmation. Sends the email again. Use Resend Invitation when you have the invitation ID.
Inputs
emailstring- The email address to search for. Example: thor@avengers.com.
cardly_order_placeOrder one or more physical cards to be printed and mailed, charging the organisation's credit.WritePlace Order
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.
Inputs
linesarrayrequired- 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_numberstring- A reference number to place against this order - useful to tie back to your existing systems for auditing. Example: PO1234.
cardly_webhook_createCreate a webhook that posts Cardly events (such as order created or sent) to your URL.WriteCreate Webhook
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.
Inputs
eventsarrayrequired- 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_urlstringrequired- 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.
descriptionstring- 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..
metadataobject- Key-value pairs to store on the webhook. Example: {"source": "crm"}.
cardly_webhook_updateUpdate a webhook's target URL, events, description, metadata or disabled flag.WriteUpdate Webhook
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.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
target_urlstringrequired- 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.
descriptionstring- 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..
disabledboolean- If supplied and truthy, disables the webhook. If supplied and falsey, enables it instead. Example: true.
eventsarray- 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"].
metadataobject- Key-value pairs to store on the webhook. Example: {"source": "crm"}.
cardly_art_deleteDelete a piece of artwork the organisation owns.DestructiveDelete Artwork
Delete a piece of artwork the organisation owns. Returns a confirmation. Use List Artwork with own_only to find its ID.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_contact_deleteDelete a contact by Cardly's contact ID, disabling linked automations.DestructiveDelete Contact
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.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
cardly_contact_delete_by_matchDelete a contact from a list, matched by external ID or email.DestructiveDelete Contact by Email or External ID
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.
- Idempotent
Inputs
list_idstringrequired- Cardly ID of the contact list. Get it from List Contact Lists. Example: a3b1c2d4-5e6f-11ee-8c99-0242ac120002.
emailstring- An email address to identify the contact to delete, if no external ID is supplied. Example: thor@avengers.com.
external_idstring- Any external identifier to identify the contact to delete, if no email address is supplied. Example: thor1234.
cardly_contact_list_deleteDelete a contact list and disable any automations linked to it.DestructiveDelete Contact List
Delete a contact list and disable any automations linked to it. Returns a confirmation. Use List Contact Lists to find the ID.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_invitation_deleteRevoke a pending invitation by ID.DestructiveDelete Invitation
Revoke a pending invitation by ID. Returns a confirmation. Use Delete Invitation by Email when you only know the address.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_invitation_delete_by_emailRevoke a pending invitation by email address.DestructiveDelete Invitation by Email
Revoke a pending invitation by email address. Returns a confirmation. Use Delete Invitation when you have the invitation ID.
- Idempotent
Inputs
emailstring- The email address to search for. Example: thor@avengers.com.
cardly_user_deleteRevoke a user's portal access by ID.DestructiveDelete User
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.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
cardly_user_delete_by_emailRevoke a user's portal access by email address.DestructiveDelete User by Email
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.
- Idempotent
Inputs
emailstring- The email address to search for. Example: thor@avengers.com.
cardly_webhook_deleteDelete a webhook and stop all its deliveries.DestructiveDelete Webhook
Delete a webhook and stop all its deliveries. Returns a confirmation. Use Update Webhook with disabled to pause it instead.
- Idempotent
Inputs
idstringrequired- Cardly unique ID (UUID) of the record. Example: fd7368b0-ad4d-11ea-9da9-04d4c4254e1b.
No tools match.