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

Tools

Slug: HANDWRYTTEN_ADD_RECIPIENTTool to add a recipient address to the user’s addressbook in Handwrytten. Use when you need to store a new recipient for sending handwritten cards.

Input Parameters

string
required
ZIP or postal code. Required for recipient.
string
required
City name. Required for recipient.
string
Full name or company name if different from first_name/last_name.
string
State or province code (e.g., ‘NY’, ‘CA’).
string
required
Primary street address line. Required for recipient.
string
Secondary street address line (apartment, suite, etc.).
string
Recipient’s birthday in MM/DD/YYYY format.
string
Recipient’s last name.
string
required
Country identifier. Use ‘1’ for USA. Required for recipient.
string
Recipient’s first name.
boolean
If true, validate the address before adding. Default: 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: HANDWRYTTEN_CALCULATE_ORDER_TAXESTool to calculate taxes for Handwrytten basket orders. Use without any parameters for basket orders, or optionally provide order details to calculate taxes for a specific order (experimental).

Input Parameters

integer
The id of the card you want to send
integer
The insert id for the order. Only if card_id is present
integer
The id of the address, required if card_id is present
integer
Optional. Use if sending a gift card. Only if card_id is present

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: HANDWRYTTEN_CHECK_AUTHTool to verify API key authentication validity for Handwrytten. Use when you need to test if the API credentials are valid and properly configured.

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: HANDWRYTTEN_CLEAR_BASKETTool to clear all items from the shopping basket. Use when you need to empty the basket and remove all pending items before starting a new order or canceling the current selection.

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: HANDWRYTTEN_CREATE_TEMPLATETool to create a new template for the current user. Use when you need to save a new message template for sending handwritten cards.

Input Parameters

string
required
Name of the template to create
string
required
Message content for the template

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: HANDWRYTTEN_CREATE_USER_ADDRESSTool to create a new user address in Handwrytten. Use when adding a new return address to a user’s profile for sending handwritten cards.

Input Parameters

string
required
ZIP or postal code (required)
string
required
City name (required)
string
Full name (alternative to first_name and last_name)
string
State or province code (required for US and Canada addresses). Use two-letter state abbreviation.
boolean
Set this return address as default
string
required
Street address (required)
string
Additional address information like apartment, suite, unit number
string
Last name (required if first_name is not present)
string
required
Country ID (required if country is not present). Use 1 for United States.
string
First name (required if last_name is not present)
string
Business name if this is a business address
boolean
Whether to validate the address

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: HANDWRYTTEN_DELETE_CUSTOM_IMAGETool to delete a custom image/logo from Handwrytten. Use when you need to remove a previously uploaded custom image or logo from your account.

Input Parameters

integer
required
The ID of the custom image 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: HANDWRYTTEN_DELETE_RECIPIENTTool to delete one or more recipient addresses from user’s profile. Use when you need to remove saved recipient addresses. Provide either address_id for single deletion or address_ids for bulk deletion.

Input Parameters

integer
The unique identifier of a single recipient address to delete. Provide either address_id (for single deletion) or address_ids (for bulk deletion), but not both. Use this when deleting one recipient at a time.
array
A list of recipient address identifiers to delete in bulk. Provide either address_id (for single deletion) or address_ids (for bulk deletion), but not both. Use this when deleting multiple recipients at once.

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: HANDWRYTTEN_DELETE_TEMPLATETool to delete a user’s template by its ID. Use when you need to remove a saved template from the user’s account.

Input Parameters

integer
required
The unique identifier of the template 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: HANDWRYTTEN_GET_BASKET_ALL_NEWTool to retrieve the user’s basket using the new method. Use when you need to fetch the current state of the shopping basket with all items, billing information, and totals.

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: HANDWRYTTEN_GET_BASKET_COUNTTool to retrieve the count of items currently in the basket. Use when you need to check how many items are in the shopping basket before proceeding with checkout or additional operations.

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: HANDWRYTTEN_GET_BASKET_ITEMTool to retrieve a basket item by its ID from Handwrytten. Use when you need to get details of a specific basket item.

Input Parameters

integer
required
Basket item id (basket_id). The unique identifier for the basket item 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: HANDWRYTTEN_GET_CARD_DETAILSGet detailed information about a specific Handwrytten catalog card, including pricing, dimensions, images, and its customization status.

Input Parameters

boolean
Optional flag to request low-resolution images. When true, returns smaller image URLs to reduce bandwidth.
integer
required
The unique identifier of the card to retrieve details 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: HANDWRYTTEN_GET_LIST_ADDRESSESTool to retrieve a list of all addresses associated with the user’s account. Use when you need to view or select from saved addresses for sending handwritten cards.

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: HANDWRYTTEN_GET_RANDOM_CARDSTool to retrieve random cards from Handwrytten. Use when you need to get a random selection of greeting cards from the Handwrytten catalog.

Input Parameters

boolean
If true, the API will render HTML instead of JSON. Set to false or omit for JSON response.
integer
Number of random cards to retrieve. If not specified, the API will return a default number of cards.
string ("L" | "P" | "F")
Orientation options for cards.

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: HANDWRYTTEN_GET_TEMPLATE_DETAILSTool to get detailed information about a card text template in the Handwrytten catalog. Use when you need to view the template message content and details.

Input Parameters

integer
required
The unique identifier of the template to retrieve details 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: HANDWRYTTEN_GET_USERTool to retrieve information about the currently authenticated user. Use when you need to fetch user profile details, account information, or verify authentication status.

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: HANDWRYTTEN_GET_USER_ADDRESSTool to retrieve the authenticated user’s address and billing information. Use when you need to access user profile address details.

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: HANDWRYTTEN_LIST_BASKET_ORDERS_GROUPEDList basket orders grouped by basket, with optional pagination, to review current basket items and pending orders.

Input Parameters

integer
Page number for pagination (1-based). Defaults to 1 if not provided.
integer
Number of items per page. Uses API default if not provided.

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: HANDWRYTTEN_LIST_BASKETSTool to retrieve a list of user’s past baskets. Use when you need to view historical basket information including orders, recipients, and totals.

Input Parameters

integer
Page number, numeration starts with 1, 50 items per page. If not set, 250 items are returned.

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: HANDWRYTTEN_LIST_CARDSTool to retrieve a list of available Handwrytten cards with optional filtering and pagination. Use when browsing card catalog or searching for specific card types.

Input Parameters

integer
Page number for pagination, starting from 0. Used to retrieve different pages of card results.
boolean
Request low-resolution images instead of full resolution. Set to true for smaller image files.
integer
Filter cards by category ID. If not provided, returns cards from all categories.
boolean
Include card images in the response. Set to true to retrieve card image URLs.

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: HANDWRYTTEN_LIST_CATEGORIESTool to retrieve the list of available card categories from Handwrytten. Use when you need to display category options or filter cards by category.

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: HANDWRYTTEN_LIST_COUNTRIESTool to retrieve the list of countries available in Handwrytten. Use when you need to get available countries for sending handwritten cards.

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: HANDWRYTTEN_LIST_CREDIT_CARDSTool to list all credit cards associated with the Handwrytten account. Use when you need to retrieve stored payment methods and billing information.

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: HANDWRYTTEN_LIST_FONTSTool to retrieve the list of available handwriting fonts. Use when you need to display font options or select a font for a handwritten message.

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: HANDWRYTTEN_LIST_FONTS_FOR_CUSTOMIZERTool to list fonts available for use with the card customizer. Use when you need to retrieve available font options for customizing handwritten cards.

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: HANDWRYTTEN_LIST_GCARDSTool to retrieve the list of available gift cards with their denominations and pricing. Use when you need to see what gift card options are available for purchase through the Handwrytten API.

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: HANDWRYTTEN_LIST_IMAGESTool to retrieve a list of custom user images uploaded to Handwrytten. Use when you need to browse or manage custom cover images or logos.

Input Parameters

string ("cover" | "logo")
Enum for image types supported by Handwrytten.

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: HANDWRYTTEN_LIST_INSERTSTool to retrieve a list of available inserts from Handwrytten. Use when you need to view all inserts that can be included with handwritten cards.

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: HANDWRYTTEN_LIST_ORDERSTool to retrieve a list of user’s past orders from Handwrytten. Use when you need to view order history or check the status of previously placed orders.

Input Parameters

integer
Page number for pagination (1-based). Defaults to 1 if not provided.
integer
Number of items per page. Uses API default if not provided.

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: HANDWRYTTEN_LIST_ORDERS_GROUPEDTool to retrieve the user’s order history grouped by basket. Use when you need to view or analyze past orders.

Input Parameters

integer
Page number for pagination (1-based). Defaults to 1 if not provided.
integer
Number of items per page. Uses API default if not provided.

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: HANDWRYTTEN_LIST_PAST_ORDERSTool to retrieve a list of user’s past orders from Handwrytten API. Use when you need to view order history or check the status of previously placed orders.

Input Parameters

integer
Page number for pagination (1-based). Defaults to 1 if not provided.
integer
Number of items per page. Uses API default if not provided.

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: HANDWRYTTEN_LIST_RECIPIENTSTool to retrieve a list of recipient addresses that the user has previously saved. Use when you need to view or select from saved recipient addresses for sending handwritten cards.

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: HANDWRYTTEN_LIST_SIGNATURESTool to retrieve the list of available signatures for use in card orders. Use when you need to display signature options or select a signature for a handwritten message.

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: HANDWRYTTEN_LIST_STATESTool to retrieve the list of states/provinces available in Handwrytten. Use when you need to get available states for addressing handwritten cards.

Input Parameters

integer
Country ID to filter states by. If not provided, returns states for all countries.

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: HANDWRYTTEN_LIST_TEMPLATE_CATEGORIESTool to retrieve the list of available template categories from Handwrytten. Use when you need to display template category options or filter templates by category.

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: HANDWRYTTEN_LIST_TEMPLATESTool to retrieve a list of card text templates from Handwrytten. Use when you need to display available templates or filter templates by category.

Input Parameters

integer
Filter templates by category ID. If not provided, returns templates from all categories.

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: HANDWRYTTEN_LOGOUTRequests logout through Handwrytten’s deprecated token logout endpoint. The endpoint invalidates legacy login/password uid tokens and is not applicable to API key authentication, which this integration uses.

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: HANDWRYTTEN_PLACE_BASKETTool to add an order to the basket in Handwrytten. Use when you need to create a new handwritten card order with specified recipients, card design, message, and delivery details. The order can be placed immediately or scheduled for future delivery.

Input Parameters

string
Font ID for handwriting style. Examples: hwJeff, astDunn, hwMercy.
string
Wishes text as part of the signature block in the letter.
integer
The ID of the card design to use for the order.
string
General message to include in all cards. Can be overridden per address in the addresses list.
boolean
Whether this order should be placed for free (requires appropriate permissions).
integer
Quantity of identical cards to send. Use when sending the same card to multiple recipients.
array
List of recipient addresses with their details. Required if address_ids is not provided. Each address can have its own message.
string
Scheduled send date and time in YYYY-MM-DD HH:MM:SS format. Leave empty for immediate sending.
integer
Font size for the handwriting. Typically ranges from 8 to 16.
integer
ID of an insert to include with the card (e.g., business card, flyer).
integer
Single address ID for sending to one recipient.
array
List of existing address IDs from Handwrytten address book. Required if addresses is not provided.
string
Coupon code to apply to this order for discounts.
integer
Signature ID for the wishes block of the message.
integer
Signature ID for the main message block.
boolean
Whether to automatically adjust font size to fit the message on the card.
boolean
Whether to check if cards and inserts are in stock. Returns error if insufficient quantity available.
integer
Denomination ID for gift cards, if applicable.
integer
ID of the return address to use. If not provided, the default return address will be used.

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: HANDWRYTTEN_REGISTER_USERTool to register a new Handwrytten user account. Use when creating a new user with email and password. Sends activation email to user; user status is not_active until email is confirmed.

Input Parameters

string
required
First name of the user.
string
required
Last name of the user.
string
required
Email address for the new user account. This will be used as the login credential.
boolean
If true, the registration notification email will not be sent to the user.
string
Full name of the user if provided.
string
required
Password for the new user account. Must meet minimum security requirements.
boolean
If true, the registration notification email will not be sent to the user.
string
Discount code managed in admin area. Used to add credits/bonus credits to the user and attach user to an existing group.
string
required
Password confirmation - must be exactly equal to the password field. Required for validation.

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: HANDWRYTTEN_REQUEST_RESET_PASSWORDTool to request a password reset email for a Handwrytten account. Use when a user needs to reset their password and requires an email with reset instructions. The API will send an email with a password reset link if the provided email exists in the system, but will return success regardless to prevent email enumeration attacks.

Input Parameters

string
required
Email address of the user requesting password reset. An email with password reset instructions will be sent if this email exists in the system.
string
required
Google reCAPTCHA token for security validation. This is required to prevent automated abuse of the password reset endpoint.

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: HANDWRYTTEN_SET_DEFAULT_ADDRESSTool to set a default return address for the user in Handwrytten. Use when you need to designate a specific address as the default return address for sending handwritten cards.

Input Parameters

integer
required
The unique ID of the address to set as default. This must be an existing address ID from the user’s address 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: HANDWRYTTEN_SET_TEST_MODEEnable or disable test mode for the current Handwrytten user. In test mode, orders are not fulfilled, credits are not deducted, and payments are authorized but not captured.

Input Parameters

integer ("0" | "1")
required
Test mode setting: enabled (1) to activate test mode where cards are not sent and charges are refunded, or disabled (0) to deactivate test mode and process real 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: HANDWRYTTEN_UPDATE_BASKETTool to update an existing basket item in Handwrytten. Use when you need to modify card details, recipient addresses, messages, or other basket item properties.

Input Parameters

integer
required
Existing basket item ID to update (required)
string
Font style to use for the handwritten message
string
Wishes text to include as part of the signature in the card
integer
ID of the card design to use
string
The handwritten message content to include in the card
boolean
Mark this basket item as free (no charge)
integer
Number of cards to send
array
List of address objects for bulk updates with custom messages
string
Date and time to send the card (format: YYYY-MM-DD HH:MM:SS)
integer
Font size for the message (in points)
integer
ID of an insert to include with the card
integer
ID of the address to use for this basket item
string
Coupon code to apply to this basket item
array
List of address IDs for bulk updates
integer
Signature ID for the wishes block of the message
integer
Signature ID for the main block of the message
boolean
Automatically adjust font size to fit the message
boolean
Check card quantity in stock, return ‘insufficient quantity’ error if low stock
integer
Gift card denomination ID (if applicable)
integer
Return address ID. If not provided, the default return address will be used

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: HANDWRYTTEN_UPDATE_BILLING_INFOTool to update user billing information (country, zip, address) for tax calculations in Handwrytten. Use when updating billing address details for accurate tax computation.

Input Parameters

string
required
ZIP or postal code for billing address (required for tax calculations)
string
required
Street address for billing (required for tax calculations)
integer
required
Country ID for billing address. Use 1 for United States.

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: HANDWRYTTEN_UPDATE_RECIPIENTTool to update a recipient address in the user’s addressbook in Handwrytten. Use when you need to modify an existing recipient’s address details.

Input Parameters

string
required
ZIP or postal code. Required for recipient update.
string
required
City name. Required for recipient update.
string
Full name or company name if different from first_name/last_name.
string
State or province code (e.g., ‘FL’, ‘CA’).
string
required
Primary street address line. Required for recipient update.
string
Secondary street address line (apartment, suite, etc.).
string
Recipient’s birthday in MM/DD/YYYY format.
string
Recipient’s last name. Required if first_name is not present.
integer
required
Unique identifier of the recipient address to update. Required.
string
required
Country identifier. Use ‘1’ for USA. Required for recipient update.
string
Recipient’s first name. Required if last_name is not present.
string
Business name if this is a business address.
boolean
If true, validate the address before updating. Default: 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: HANDWRYTTEN_UPDATE_TEMPLATETool to update an existing user template in Handwrytten. Use when you need to modify a template’s name or message content.

Input Parameters

string
required
Updated name for the template (required)
string
required
Updated message content for the template (required)
integer
required
ID of the template to update (required)

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: HANDWRYTTEN_UPLOAD_CUSTOM_LOGOTool to upload a custom image (logo or cover) to Handwrytten for use with custom cards. Use when you need to add a custom logo or cover image that can be referenced in future card creation requests.

Input Parameters

object
required
The image file to upload. Supported formats: PNG, JPG, JPEG.
string ("cover" | "logo")
Type of custom image being uploaded

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