Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to test email templates within the Email Settings resource. It allows users to send test emails based on various predefined email template types, such as invoices, reminders, and activation emails. This is useful for verifying the appearance and content of email templates before sending them to actual recipients, ensuring correctness and professionalism in communication.

Use Case Examples

  1. A user wants to test the 'Invoice' email template by sending a sample email to a specified address to verify the layout and content.
  2. A user needs to check the 'Customer Access Activation' email template to ensure the activation link and message are correctly formatted before enabling it for customers.

Properties

Name Meaning
Organisation Id Unique identifier for the organisation to which the email template belongs. Required to specify the context for the email template test.
Email Template Type Specifies the type of email template to test, such as invoice, invoicereminder, creditnote, etc. Determines which template content is used for the test email.
Additional Body Fields Optional collection of additional fields to customize the test email body, including email address, JSON model, template type, name, subject, and HTML body content.

Output

JSON

  • data - Response data from the Billing Booth One API after testing the email template, typically including success status and any relevant message or details.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Ensure the organisation ID is valid and corresponds to an existing organisation in the Billing Booth One system.
  • Verify that the selected email template type is supported and correctly spelled.
  • If the test email fails to send, check the API key credentials and network connectivity.
  • Common error messages may include authorization errors (invalid API key), missing required parameters, or invalid email addresses. Resolving these involves verifying credentials, input parameters, and email format.

Discussion