Reference

Create User Address

Add a new return address to your Handwrytten profile so recipients know where your handwritten cards are coming from. This ensures your contact information appears on outgoing cards and mail.

Get List of Addresses

Retrieve all saved addresses from your account to view, manage, or select addresses for sending handwritten cards and mailings.

Get User Address

Retrieves your account's address and billing information from your Handwrytten profile, allowing you to confirm or reference your registered details for shipments and records.

Set Default Address

Designate a specific address as your default return address for handwritten cards sent through Handwrytten, ensuring your business location appears consistently on all outgoing correspondence.

Check Authentication

Verifies that your Handwrytten API credentials are valid and properly configured so you can confirm your connection is working before sending campaigns.

Logout User

Ends the current user session and invalidates authentication, ensuring secure termination of access to the Handwrytten application.

Request Password Reset

Sends a password reset email to a specified account, allowing users to securely regain access to their Handwrytten account when they've forgotten their credentials.

List Credit Cards

Retrieve all credit cards linked to your Handwrytten account to view and manage your stored payment methods for sending handwritten cards.

Update Billing Information

Update your billing address and location details to ensure accurate tax calculations and invoice processing for your Handwrytten account.

Get Card Details

Retrieve complete details about a specific card in your Handwrytten catalog, including pricing, dimensions, images, and available customization options. Use this to verify card specifications before placing orders or promoting cards to clients.

Get Random Cards

Retrieves a random selection of greeting cards from Handwrytten's catalog to help you discover card designs and options without browsing through the entire collection.

List Cards

Retrieve all available Handwrytten card designs with filtering and pagination options to browse your card catalog and find the right card for your needs.

Get Basket (New Method)

Retrieve your complete shopping basket including all items, quantities, pricing, and billing details to view what's ready for checkout.

Clear Basket

Removes all items from your shopping basket in one action, allowing you to start fresh with a new order or discard your current selection without processing individual item removals.

Get Basket Count

Retrieves the current number of items in a customer's shopping basket to help manage orders and inventory before checkout. Useful for tracking what customers have selected and ensuring accurate order fulfillment.

Get Basket Item

Retrieve details about a specific item in your Handwrytten basket, such as recipient information, card design, and personalization details. This helps you verify order contents before checkout or manage pending handwritten card campaigns.

List Basket Orders Grouped

Retrieve all items in your basket organized by grouping, allowing you to review and manage pending orders before checkout or sending.

List Past Baskets

Retrieve all your past handwritten card baskets to review previous orders, recipients, and spending history. Helps you track which customers or prospects received cards and manage your outreach records.

Update Basket Item

Modify card details, recipient addresses, messages, or other properties of items already in your Handwrytten basket before sending. Use this to correct mistakes, update recipient information, or personalize messages without losing your shopping progress.

List Categories

Retrieve all available card categories from Handwrytten to help you browse and organize your card options by type. This is useful when you want to see what categories of cards are available before sending personalized messages.

Set Test Mode

Toggle test mode on or off to safely test your handwritten card campaigns without incurring charges or actually sending cards. When enabled, no cards will be mailed and funds are returned to your account.

List Fonts

Retrieve all available handwriting fonts so you can choose the perfect style for your personalized handwritten messages. This helps you preview font options before sending cards or notes to customers and clients.

List Fonts for Customizer

Retrieve the available fonts you can use to customize handwritten cards, allowing you to see all styling options before designing your message.

List Gift Cards

Retrieve all available gift card options with their denominations and pricing to help you understand what you can offer to customers. This lets you quickly see your gift card inventory and pricing before promoting or selling them.

List Inserts

Retrieve all available inserts that can be added to handwritten cards, helping you see what supplementary content options are available for your mailings.

List Countries

Retrieves all available countries where you can send handwritten cards through Handwrytten. This helps you determine which locations you can reach before creating and sending personalized cards to customers, partners, or prospects.

List States

Retrieve all available states and provinces supported by Handwrytten for addressing handwritten cards and mailings. Use this when you need to validate or populate location data for your card campaigns.

Delete Custom Image

Remove a custom image or logo from your Handwrytten account when you no longer need it or want to update your branding materials.

List Custom User Images

Retrieve all custom images you've uploaded to Handwrytten, including cover photos and logos, so you can manage and reuse them across your handwritten card campaigns.

Upload Custom Logo

Add your company logo or custom cover image to Handwrytten so you can include branded visuals on personalized cards sent to clients and prospects.

List Orders

Retrieve your complete history of handwritten note orders to review past campaigns, check delivery statuses, and manage your communication records.

Place Order in Basket

Add a personalized handwritten card order to your basket with custom recipients, designs, messages, and delivery options, either for immediate or scheduled sending.

Calculate Order Taxes

Calculates tax amounts for Handwrytten orders so you can provide accurate pricing to customers before checkout. Automatically determines applicable taxes based on your order details and location.

List Orders Grouped

Retrieve your handwritten card order history organized by purchase basket, making it easy to see what you've ordered and when. This helps you track your marketing campaigns and correspondence efforts over time.

List Past Orders

Retrieve your complete order history from Handwrytten to review past handwritten card and letter orders, track order statuses, and verify delivery details.

Add Recipient

Store a new recipient's mailing address in your Handwrytten addressbook so you can quickly send them handwritten cards without re-entering their details each time.

List Recipients

Retrieve all saved recipient addresses you've previously stored, making it easy to quickly select addresses when sending handwritten cards without re-entering contact information.

Delete Recipient Address

Remove saved recipient addresses from your profile to keep your contact list clean and up-to-date. Use this when you no longer need to send handwritten notes to certain addresses or want to organize your recipients.

Update Recipient

Modify an existing recipient's address details in your Handwrytten addressbook to keep contact information current and accurate for sending handwritten cards and letters.

List Signatures

Retrieves all available signatures that can be added to handwritten cards and messages. Use this to view your signature options or programmatically select which signature to include with each card order.

Create Template

Save a custom message template for handwritten cards that you can reuse across multiple mailings. This lets you maintain consistent messaging while speeding up your card creation process.

List Templates

Retrieve all available card text templates from Handwrytten to see what pre-written messages you can use for your handwritten cards. This helps you quickly find the right template for different occasions without writing from scratch.

Delete Template

Remove a saved handwritten card template from your account when it's no longer needed or you want to clean up your template library.

Get Template Details

Retrieve detailed information about a specific handwritten card template, including the message content and design details, to preview what your recipients will receive.

List Template Categories

Retrieve all available template categories from Handwrytten to discover and organize different types of handwritten message designs. This helps you quickly find the right template style for your communication needs.

Update Template

Modify an existing template's name or message content to keep your handwritten communication templates current and aligned with your brand voice or campaign needs.

Get Current User Info

Retrieves your account profile and details to verify your authenticated access and understand your account settings. Use this to confirm your user information and account status within the platform.

Register User

Creates a new Handwrytten user account with email and password credentials, then sends an activation email to verify the account before it becomes active.