Skip to content
Changelog

Report a bug

Cardly integration: operations for AI agents

Cardly connects to Type.com as an integration. This page lists the 48 operations documented for Claude and Codex in Type.com: 25 read, 14 write, 9 destructive.

About Cardly

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

Categories: Marketing & Social

How to connect Cardly to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

48 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

48 operations listed.

Testing & Development

  • Write

    Echo Request

    The echo endpoint will take any parameters, body structure and headers and return them to you in a JSON structure.

Account

  • Read

    Retrieve Account Balance

    This endpoint allows you to quickly query the current balance for your organisation. Where relevant, API calls which consume or have the potential to consume balance will return your organisation's balance in the return structure for convenience.

  • Read

    List Credit History

    Retrieve a section of balance history records pertaning to your organistaion. This will list both credits and debits, along with links / reasons for each, where applicable. This request accepts standard pagination options limit, offset along with the following additional filters:

  • Read

    List Gift Credit History

    Retrieve a section of gift credit history records pertaning to your organistaion. This will list both credits and debits, along with links / reasons for each, where applicable.

Artwork

  • Read

    List Artwork

    Retrieve the currently available artwork for your organisation. This request accepts standard pagination options limit, offset along with the following additional filters:

  • Read

    Retrieve Artwork

    Retrieve information on a specific piece of artwork.

  • Write

    Create Artwork

    Add a new piece of artwork.

  • Write

    Edit Artwork

    Update a piece of artwork with new descriptors or images. All parameters are optional, and only supplied parameters will be updated.

  • Destructive

    Delete Artwork

    Delete a piece of artwork owned by your organisation.

Contact Lists

  • Read

    List Contact Lists

    Retrieve active contact lists for your organisation.

  • Read

    Retrieve Contact List

    Retrieve information on a specific contact list.

  • Write

    Create Contact List

    Add a new contact list, optionally with custom fields.

  • Destructive

    Delete Contact List

    Delete a contact list, disabling any automations linked to it.

Contacts

  • Read

    List Contacts

    Retrieve active contacts in a given list.

  • Read

    Retrieve Contact

    Retrieve information on a specific contact from a given list, identified by Cardly's unique identifier for the record.

  • Read

    Search Contacts

    Retrieve information on a specific contact from a given list, searching for the contact by an email address or previously supplied external identifier.

  • Write

    Create Contact

    Add a new contact to a given list. Please note: contacts added via API calls will be checked for uniqueness based on your externalId and email fields, if supplied. If a contact already exists for one of these fields the addition operation will be rejected.

  • Write

    Edit Contact

    Edit an existing contact, providing updated information for the contact record.

  • Write

    Sync Contact

    Sync a contact based on an external ID or email address. If a matching contact does not exist, a new one is created, otherwise existing contact records are updated. Previously removed contacts will be reactivated if they match provided details.

  • Destructive

    Delete Contact

    Delete a contact, disabling any automations linked to it. Contact matching is performed in order of matching external ID or email address. At least one of these details must be provided.

  • Destructive

    Delete Contact

    Delete a contact, disabling any automations linked to it.

Doodles

  • Read

    List Doodles

    Retrieve your currently available doodles. This request accepts standard pagination options limit, offset along with the following additional filters:

Fonts

  • Read

    List Fonts

    Retrieve your currently available fonts. This request accepts standard pagination options limit, offset along with the following additional filters:

Invitations

  • Read

    List Invitations

    Retrieve active invitations for your organisation. This request accepts standard pagination options limit, offset along with the following additional filters:

  • Read

    Retrieve Invitation

    Retrieve information on a specific invitation, identified by Cardly's unique identifier for the record.

  • Read

    Find Invitation

    Retrieve information on a specific invitation, searching by a provided email address.

  • Write

    Create Invitation

    Send an invitation to use your organisation portal, if the provided email address doesn't already have access.

  • Write

    Resend Invitation by Email

    Resend an invitation to a specified email address if that invitation has not yet been accepted.

  • Write

    Resend Invitation

    Resend an invitation identified by Cardly's unique ID.

  • Destructive

    Delete Invitation by Email

    Delete an invitation by email address, immediately invalidating it for acceptance.

  • Destructive

    Delete Invitation

    Delete an invitation by unique ID address, immediately invalidating it for acceptance.

Media

  • Read

    List Media

    Retrieve the currently available media sizes for product artwork. This request accepts standard pagination options limit, offset along with the following additional filters:

Orders

  • Read

    List Orders

    Retrieve orders placed by your organisation.

  • Read

    Retrieve Order

    Retrieve information on a specific order.

  • Write

    Generate Preview

    The preview endpoint allows you to generate a quick, low-quality, watermarked preview document for a given piece of card art and template, along with passed user data.

  • Write

    Place Order

    The place endpoint allows you to place an order for one or more items, being delivered to one or more distinct recipients. Generally, we recommend that individual orders are created for individual recipients to minimise potential validation and other rejection issues.

Templates

  • Read

    List Templates

    Retrieve your currently available templates.

Users

  • Read

    List Users

    Retrieve active users for your organisation.

  • Read

    Retrieve User

    Retrieve information on a specific user, identified by Cardly's unique identifier for the record.

  • Read

    Find User

    Retrieve information on a specific user, searching by a provided email address.

  • Destructive

    Delete User by Email

    Delete a user by email address, immediately revoking their access to your organisation portal. Please note: Access can not be removed for users with administrator privileges on your account. These must be removed via your portal directly.

  • Destructive

    Delete user

    Delete a user by unique ID address, immediately revoking their access to your organisation portal. Please note: Access can not be removed for users with administrator privileges on your account. These must be removed via your portal directly.

Webhooks

  • Read

    List Webhooks

    Retrieve any active or disabled webhooks set up for your organisation.

  • Read

    Get Webhook Details

    Get details on an existing webhook.

  • Write

    Create Webhook

    Create a new webhook for the specified targetUrl. Webhooks allow for near-realtime notifications of events within your Cardly account.

  • Write

    Update Webhook

    Update a webhook with one or more changes based on the passed properties. Note that changes to the targetUrl or status are immediate, and will update where postbacks are sent for any postbacks queued for retry, or cease sending postbacks if disabled is true.

  • Destructive

    Delete Webhook

    Delete a given webhook and cease all activity and event subscriptions immediately.

Writing Styles

  • Read

    List Writing Styles

    Retrieve your currently available writing styles.

See How connections work for access and permissions, or browse all integrations.