NAiOS IconNAiOS Logo
Contacto
Contacto

Suscríbete a la newsletter

Novedades de IA y de producto. Sin spam, puedes darte de baja cuando quieras.

Consejo: usa tu email de empresa para una respuesta más relevante.

Comprobando seguridad…
NAiOS Icon
NAiOS Logo

El primer integrador de IA para empresas reales. Conecta todas tus herramientas de IA de forma segura y escalable.

+34 695482054info@naios.netinfo@netretina.ai
LinkedInNAiOS AcademyNetretina.AiContact UsX

Plataforma

  • Características
  • Integraciones
  • Planes y precios

Empresa

  • Sobre nosotros
  • Blog
  • Contacto

Compliance

  • Reglamento Europeo de IA
  • Transparencia de IA

Legal

  • Aviso legal
  • Política de privacidad
  • Términos y condiciones
  • Política de cookies
  • Devoluciones

© 2026 NAiOS. Todos los derechos reservados.

Un producto de Netretina.Ai

    Volver al catálogo

    Handwrytten

    handwrytten

    Automate your handwritten correspondence. Send real notes with your message written in pen by robots.

    Marketing AutomationCustomer AppreciationWeb del proveedor
    Acciones
    48
    Triggers
    0
    Autenticación
    —
    OAuth gestionado
    No
    Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

    Acciones disponibles (48)

    Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

    Add RecipientHANDWRYTTEN_ADD_RECIPIENTAcción

    Tool 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.

    Parámetros de entrada

    • zipstringObligatorio

      ZIP or postal code. Required for recipient.

    • citystringObligatorio

      City name. Required for recipient.

    • namestring

      Full name or company name if different from first_name/last_name.

    • statestring

      State or province code (e.g., 'NY', 'CA').

    • address1stringObligatorio

      Primary street address line. Required for recipient.

    • address2string

      Secondary street address line (apartment, suite, etc.).

    • birthdaystring

      Recipient's birthday in MM/DD/YYYY format.

    • last_namestring

      Recipient's last name.

    • country_idstringObligatorio

      Country identifier. Use '1' for USA. Required for recipient.

    • first_namestring

      Recipient's first name.

    • validate_addressboolean

      If true, validate the address before adding. Default: false.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Calculate Order TaxesHANDWRYTTEN_CALCULATE_ORDER_TAXESAcción

    Tool 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).

    Parámetros de entrada

    • card_idinteger

      The id of the card you want to send

    • insert_idinteger

      The insert id for the order. Only if card_id is present

    • address_idinteger

      The id of the address, required if card_id is present

    • denomination_idinteger

      Optional. Use if sending a gift card. Only if card_id is present

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Check AuthenticationHANDWRYTTEN_CHECK_AUTHAcción

    Tool to verify API key authentication validity for Handwrytten. Use when you need to test if the API credentials are valid and properly configured.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Clear BasketHANDWRYTTEN_CLEAR_BASKETAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Create TemplateHANDWRYTTEN_CREATE_TEMPLATEAcción

    Tool to create a new template for the current user. Use when you need to save a new message template for sending handwritten cards.

    Parámetros de entrada

    • namestringObligatorio

      Name of the template to create

    • messagestringObligatorio

      Message content for the template

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Create User AddressHANDWRYTTEN_CREATE_USER_ADDRESSAcción

    Tool to create a new user address in Handwrytten. Use when adding a new return address to a user's profile for sending handwritten cards.

    Parámetros de entrada

    • zipstringObligatorio

      ZIP or postal code (required)

    • citystringObligatorio

      City name (required)

    • namestring

      Full name (alternative to first_name and last_name)

    • statestring

      State or province code (required for US and Canada addresses). Use two-letter state abbreviation.

    • defaultboolean

      Set this return address as default

    • address1stringObligatorio

      Street address (required)

    • address2string

      Additional address information like apartment, suite, unit number

    • last_namestring

      Last name (required if first_name is not present)

    • country_idstringObligatorio

      Country ID (required if country is not present). Use 1 for United States.

    • first_namestring

      First name (required if last_name is not present)

    • business_namestring

      Business name if this is a business address

    • validate_addressboolean

      Whether to validate the address

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Delete Custom ImageHANDWRYTTEN_DELETE_CUSTOM_IMAGEAcción

    Tool to delete a custom image/logo from Handwrytten. Use when you need to remove a previously uploaded custom image or logo from your account.

    Parámetros de entrada

    • image_idintegerObligatorio

      The ID of the custom image to delete.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Delete Recipient AddressHANDWRYTTEN_DELETE_RECIPIENTAcción

    Tool 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.

    Parámetros de entrada

    • address_idinteger

      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.

    • address_idsinteger[]

      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.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Delete TemplateHANDWRYTTEN_DELETE_TEMPLATEAcción

    Tool to delete a user's template by its ID. Use when you need to remove a saved template from the user's account.

    Parámetros de entrada

    • template_idintegerObligatorio

      The unique identifier of the template to delete

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Basket (New Method)HANDWRYTTEN_GET_BASKET_ALL_NEWAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Basket CountHANDWRYTTEN_GET_BASKET_COUNTAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Basket ItemHANDWRYTTEN_GET_BASKET_ITEMAcción

    Tool to retrieve a basket item by its ID from Handwrytten. Use when you need to get details of a specific basket item.

    Parámetros de entrada

    • idintegerObligatorio

      Basket item id (basket_id). The unique identifier for the basket item to retrieve.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Card DetailsHANDWRYTTEN_GET_CARD_DETAILSAcción

    Tool to get detailed information about a specific card in the Handwrytten catalog. Use when you need comprehensive details about a card including pricing, dimensions, images, and customization options.

    Parámetros de entrada

    • lowresboolean

      Optional flag to request low-resolution images. When true, returns smaller image URLs to reduce bandwidth.

    • card_idintegerObligatorio

      The unique identifier of the card to retrieve details for.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get List of AddressesHANDWRYTTEN_GET_LIST_ADDRESSESAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Random CardsHANDWRYTTEN_GET_RANDOM_CARDSAcción

    Tool to retrieve random cards from Handwrytten. Use when you need to get a random selection of greeting cards from the Handwrytten catalog.

    Parámetros de entrada

    • htmlboolean

      If true, the API will render HTML instead of JSON. Set to false or omit for JSON response.

    • card_numberinteger

      Number of random cards to retrieve. If not specified, the API will return a default number of cards.

    • orientationstringenum

      Orientation options for cards.

      LPF

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Template DetailsHANDWRYTTEN_GET_TEMPLATE_DETAILSAcción

    Tool 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.

    Parámetros de entrada

    • template_idintegerObligatorio

      The unique identifier of the template to retrieve details for.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get Current User InfoHANDWRYTTEN_GET_USERAcción

    Tool to retrieve information about the currently authenticated user. Use when you need to fetch user profile details, account information, or verify authentication status.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Get User AddressHANDWRYTTEN_GET_USER_ADDRESSAcción

    Tool to retrieve the authenticated user's address and billing information. Use when you need to access user profile address details.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Basket Orders GroupedHANDWRYTTEN_LIST_BASKET_ORDERS_GROUPEDAcción

    Tool to list all basket orders grouped by basket. Use when you need to retrieve all items currently in the user's basket or review pending orders.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Past BasketsHANDWRYTTEN_LIST_BASKETSAcción

    Tool to retrieve a list of user's past baskets. Use when you need to view historical basket information including orders, recipients, and totals.

    Parámetros de entrada

    • pageinteger

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

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List CardsHANDWRYTTEN_LIST_CARDSAcción

    Tool to retrieve a list of available Handwrytten cards with optional filtering and pagination. Use when browsing card catalog or searching for specific card types.

    Parámetros de entrada

    • pageinteger

      Page number for pagination, starting from 0. Used to retrieve different pages of card results.

    • lowresboolean

      Request low-resolution images instead of full resolution. Set to true for smaller image files.

    • category_idinteger

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

    • with_imagesboolean

      Include card images in the response. Set to true to retrieve card image URLs.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List CategoriesHANDWRYTTEN_LIST_CATEGORIESAcción

    Tool to retrieve the list of available card categories from Handwrytten. Use when you need to display category options or filter cards by category.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List CountriesHANDWRYTTEN_LIST_COUNTRIESAcción

    Tool to retrieve the list of countries available in Handwrytten. Use when you need to get available countries for sending handwritten cards.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Credit CardsHANDWRYTTEN_LIST_CREDIT_CARDSAcción

    Tool to list all credit cards associated with the Handwrytten account. Use when you need to retrieve stored payment methods and billing information.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List FontsHANDWRYTTEN_LIST_FONTSAcción

    Tool to retrieve the list of available handwriting fonts. Use when you need to display font options or select a font for a handwritten message.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Fonts for CustomizerHANDWRYTTEN_LIST_FONTS_FOR_CUSTOMIZERAcción

    Tool to list fonts available for use with the card customizer. Use when you need to retrieve available font options for customizing handwritten cards.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Gift CardsHANDWRYTTEN_LIST_GCARDSAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Custom User ImagesHANDWRYTTEN_LIST_IMAGESAcción

    Tool to retrieve a list of custom user images uploaded to Handwrytten. Use when you need to browse or manage custom cover images or logos.

    Parámetros de entrada

    • typestringenum

      Enum for image types supported by Handwrytten.

      coverlogo

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List InsertsHANDWRYTTEN_LIST_INSERTSAcción

    Tool to retrieve a list of available inserts from Handwrytten. Use when you need to view all inserts that can be included with handwritten cards.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List OrdersHANDWRYTTEN_LIST_ORDERSAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Orders GroupedHANDWRYTTEN_LIST_ORDERS_GROUPEDAcción

    Tool to retrieve the user's order history grouped by basket. Use when you need to view or analyze past orders.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Past OrdersHANDWRYTTEN_LIST_PAST_ORDERSAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List RecipientsHANDWRYTTEN_LIST_RECIPIENTSAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List SignaturesHANDWRYTTEN_LIST_SIGNATURESAcción

    Tool 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.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List StatesHANDWRYTTEN_LIST_STATESAcción

    Tool to retrieve the list of states/provinces available in Handwrytten. Use when you need to get available states for addressing handwritten cards.

    Parámetros de entrada

    • country_idinteger

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

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List Template CategoriesHANDWRYTTEN_LIST_TEMPLATE_CATEGORIESAcción

    Tool to retrieve the list of available template categories from Handwrytten. Use when you need to display template category options or filter templates by category.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    List TemplatesHANDWRYTTEN_LIST_TEMPLATESAcción

    Tool to retrieve a list of card text templates from Handwrytten. Use when you need to display available templates or filter templates by category.

    Parámetros de entrada

    • category_idinteger

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

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Logout UserHANDWRYTTEN_LOGOUTAcción

    Tool to logout user from Handwrytten application. Use when you need to terminate the current user session and invalidate the authentication token.

    Parámetros de entrada

    Sin parámetros.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Place Order in BasketHANDWRYTTEN_PLACE_BASKETAcción

    Tool 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.

    Parámetros de entrada

    • fontstring

      Font ID for handwriting style. Examples: hwJeff, astDunn, hwMercy.

    • wishesstring

      Wishes text as part of the signature block in the letter.

    • card_idinteger

      The ID of the card design to use for the order.

    • messagestring

      General message to include in all cards. Can be overridden per address in the addresses list.

    • for_freeboolean

      Whether this order should be placed for free (requires appropriate permissions).

    • quantityinteger

      Quantity of identical cards to send. Use when sending the same card to multiple recipients.

    • addressesobject[]

      List of recipient addresses with their details. Required if address_ids is not provided. Each address can have its own message.

    • date_sendstring

      Scheduled send date and time in YYYY-MM-DD HH:MM:SS format. Leave empty for immediate sending.

    • font_sizeinteger

      Font size for the handwriting. Typically ranges from 8 to 16.

    • insert_idinteger

      ID of an insert to include with the card (e.g., business card, flyer).

    • address_idinteger

      Single address ID for sending to one recipient.

    • address_idsinteger[]

      List of existing address IDs from Handwrytten address book. Required if addresses is not provided.

    • coupon_codestring

      Coupon code to apply to this order for discounts.

    • signature_idinteger

      Signature ID for the wishes block of the message.

    • signature2_idinteger

      Signature ID for the main message block.

    • auto_font_sizeboolean

      Whether to automatically adjust font size to fit the message on the card.

    • check_quantityboolean

      Whether to check if cards and inserts are in stock. Returns error if insufficient quantity available.

    • denomination_idinteger

      Denomination ID for gift cards, if applicable.

    • return_address_idinteger

      ID of the return address to use. If not provided, the default return address will be used.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Register UserHANDWRYTTEN_REGISTER_USERAcción

    Tool 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.

    Parámetros de entrada

    • fnamestringObligatorio

      First name of the user.

    • lnamestringObligatorio

      Last name of the user.

    • loginstringObligatorio

      Email address for the new user account. This will be used as the login credential.

    • silentboolean

      If true, the registration notification email will not be sent to the user.

    • fullnamestring

      Full name of the user if provided.

    • passwordstringObligatorio

      Password for the new user account. Must meet minimum security requirements.

    • silent_addboolean

      If true, the registration notification email will not be sent to the user.

    • discount_codestring

      Discount code managed in admin area. Used to add credits/bonus credits to the user and attach user to an existing group.

    • password_confirmationstringObligatorio

      Password confirmation - must be exactly equal to the password field. Required for validation.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Request Password ResetHANDWRYTTEN_REQUEST_RESET_PASSWORDAcción

    Tool 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.

    Parámetros de entrada

    • loginstringObligatorio

      Email address of the user requesting password reset. An email with password reset instructions will be sent if this email exists in the system.

    • g_recaptcha_responsestringObligatorio

      Google reCAPTCHA token for security validation. This is required to prevent automated abuse of the password reset endpoint.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Set Default AddressHANDWRYTTEN_SET_DEFAULT_ADDRESSAcción

    Tool 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.

    Parámetros de entrada

    • idintegerObligatorio

      The unique ID of the address to set as default. This must be an existing address ID from the user's address list.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Set Test ModeHANDWRYTTEN_SET_TEST_MODEAcción

    Tool to set test mode for the current Handwrytten user. Use when you need to enable or disable test mode for testing purposes. When enabled, cards will not be sent and money will be returned to the credit card.

    Parámetros de entrada

    • test_modeintegerObligatorioenum

      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.

      01

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Update Basket ItemHANDWRYTTEN_UPDATE_BASKETAcción

    Tool to update an existing basket item in Handwrytten. Use when you need to modify card details, recipient addresses, messages, or other basket item properties.

    Parámetros de entrada

    • idintegerObligatorio

      Existing basket item ID to update (required)

    • fontstring

      Font style to use for the handwritten message

    • wishesstring

      Wishes text to include as part of the signature in the card

    • card_idinteger

      ID of the card design to use

    • messagestring

      The handwritten message content to include in the card

    • for_freeboolean

      Mark this basket item as free (no charge)

    • quantityinteger

      Number of cards to send

    • addressesobject[]

      List of address objects for bulk updates with custom messages

    • date_sendstring

      Date and time to send the card (format: YYYY-MM-DD HH:MM:SS)

    • font_sizeinteger

      Font size for the message (in points)

    • insert_idinteger

      ID of an insert to include with the card

    • address_idinteger

      ID of the address to use for this basket item

    • couponCodestring

      Coupon code to apply to this basket item

    • address_idsinteger[]

      List of address IDs for bulk updates

    • signature_idinteger

      Signature ID for the wishes block of the message

    • signature2_idinteger

      Signature ID for the main block of the message

    • auto_font_sizeboolean

      Automatically adjust font size to fit the message

    • check_quantityboolean

      Check card quantity in stock, return 'insufficient quantity' error if low stock

    • denomination_idinteger

      Gift card denomination ID (if applicable)

    • return_address_idinteger

      Return address ID. If not provided, the default return address will be used

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Update Billing InformationHANDWRYTTEN_UPDATE_BILLING_INFOAcción

    Tool to update user billing information (country, zip, address) for tax calculations in Handwrytten. Use when updating billing address details for accurate tax computation.

    Parámetros de entrada

    • zipstringObligatorio

      ZIP or postal code for billing address (required for tax calculations)

    • addressstringObligatorio

      Street address for billing (required for tax calculations)

    • country_idintegerObligatorio

      Country ID for billing address. Use 1 for United States.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Update RecipientHANDWRYTTEN_UPDATE_RECIPIENTAcción

    Tool to update a recipient address in the user's addressbook in Handwrytten. Use when you need to modify an existing recipient's address details.

    Parámetros de entrada

    • zipstringObligatorio

      ZIP or postal code. Required for recipient update.

    • citystringObligatorio

      City name. Required for recipient update.

    • namestring

      Full name or company name if different from first_name/last_name.

    • statestring

      State or province code (e.g., 'FL', 'CA').

    • address1stringObligatorio

      Primary street address line. Required for recipient update.

    • address2string

      Secondary street address line (apartment, suite, etc.).

    • birthdaystring

      Recipient's birthday in MM/DD/YYYY format.

    • last_namestring

      Recipient's last name. Required if first_name is not present.

    • address_idintegerObligatorio

      Unique identifier of the recipient address to update. Required.

    • country_idstringObligatorio

      Country identifier. Use '1' for USA. Required for recipient update.

    • first_namestring

      Recipient's first name. Required if last_name is not present.

    • business_namestring

      Business name if this is a business address.

    • validate_addressboolean

      If true, validate the address before updating. Default: false.

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Update TemplateHANDWRYTTEN_UPDATE_TEMPLATEAcción

    Tool to update an existing user template in Handwrytten. Use when you need to modify a template's name or message content.

    Parámetros de entrada

    • namestringObligatorio

      Updated name for the template (required)

    • messagestringObligatorio

      Updated message content for the template (required)

    • template_idintegerObligatorio

      ID of the template to update (required)

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not

    Upload Custom LogoHANDWRYTTEN_UPLOAD_CUSTOM_LOGOAcción

    Tool 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.

    Parámetros de entrada

    • fileobjectObligatorio

      The image file to upload. FileUploadable object where 'name' is the filename (e.g., 'logo.png'). Supported formats: PNG, JPG, JPEG.

    • typestringenum

      Type of custom image being uploaded

      coverlogo

    Parámetros de salida

    • dataobjectObligatorio

      Data from the action execution

    • errorstring

      Error if any occurred during the execution of the action

    • successfulbooleanObligatorio

      Whether or not the action execution was successful or not