Handwrytten — Send Real Handwritten Notes
You have access to the Handwrytten API, which sends real handwritten notes using robots with actual pens writing on physical cards that get mailed to recipients.
Typical Workflow
- Browse options first: Call
list_cardsandlist_fontsto discover available card templates and handwriting styles before sending. - Send the note: Call
send_orderwith a card ID, font ID, message, and sender address and recipient address. If you want the sign-off on the right side of the card, include thewishesparameter with the sign-off message. - Confirm to the user: Always tell the user what card, font, and message you selected, and confirm before placing an order that costs money.
Key Tools
Sending Notes (Core)
send_order— The primary tool. Sends a handwritten note. Supports single recipients (address object or saved ID) and bulk sends (array of recipients with optional per-recipient message overrides). Always calllist_cardsandlist_fontsfirst.get_order/list_orders— Check order status and history.
Browsing Cards & Fonts
list_cards— Browse card templates. Supports filtering by category name/ID and search by name. Uselist_card_categoriesto discover category IDs. Results are paginated (default 20/page).list_fonts— Browse handwriting styles for the order message.list_customizer_fonts— Browse printed/typeset fonts (only needed for custom card text zones, not for order messages).
Address Book
list_recipients/add_recipient/update_recipient/delete_recipient— Manage saved recipient addresses.list_senders/add_sender/delete_sender— Manage saved return addresses.list_countries/list_states— Look up supported countries and state codes.
Extras
list_gift_cards— Browse gift cards to attach to orders (passdenominationIdtosend_order).list_inserts— Browse physical inserts (business cards, flyers) to include in orders.list_signatures— List saved handwriting signatures.calculate_targets— Prospect mailing targets by ZIP code and radius.
Custom Cards (Advanced)
For creating custom card designs with logos, images, and printed text:
list_custom_card_dimensions— Get available card formats (flat/folded, portrait/landscape).upload_custom_image— Upload a cover or logo image (JPEG/PNG/GIF via public URL).create_custom_card— Build the card design with zones (header, main, footer, back). Each zone has atypefield: settype='logo'when using a logo image,type='text'for printed text.- Use the resulting card ID with
send_orderto mail it.
QR Codes
create_qr_code/list_qr_codes/delete_qr_code— Manage QR codes that can be placed on custom cards.list_qr_code_frames— Browse decorative frames for QR codes.
Basket (Multi-Step Orders)
For building up multiple orders before submitting them together:
basket_add_order→basket_list→basket_send- Use
send_orderinstead for simple single-step sends.
Important Guidelines
- Always browse before sending. Call
list_cardsandlist_fontsbeforesend_orderso you use valid IDs. - Confirm before ordering. Sending a note costs money and results in a physical card being mailed. Always confirm the details with the user before calling
send_order. - Addresses require: firstName, lastName, street1, city, state, zip. Country defaults to US.
- Bulk sends: Pass an array of recipients to
send_order. Each recipient can have per-recipientmessageandwishesoverrides. - Scheduling: Use the
dateSendparameter (YYYY-MM-DD) to schedule a future send. - Account balance: Call
get_userto check the user's credits balance.