Email Template Object

The Email Template object defines the structure and content of an email used by the CarrierX platform for system-generated messages such as verification requests, password resets, invoices, and partner notifications.

Each template includes sender and recipient details, message bodies (HTML and plain text), subject line, and a secure template ID. Templates also have a type field that identifies their specific purpose — for example, account verification or low-balance notifications.

This object enables consistent formatting and branding across all automated communications, ensuring that system emails maintain uniform style and content integrity.

Supported template types include:

• email_address_verification – used for verification emails.
• email_partner_review – used for partner review notifications.
• forgot_partner_password – used for password reset emails.
• invoice – used for billing and invoicing messages.
• low_balance_partner_notification – used to warn partners of low account balance.
• new_partner_welcome – used for new partner welcome messages.
• suspended_partner_notification – used to notify partners of service suspension.

Email Template Object Attributes

This is the JSON response that gets returned when a request is successful.

Attribute	Data Type	Description
bcc_addresses read only	string	The addresses of the recipients to appear in the BCC field.
cc_addresses read only	string	The addresses of the recipients to appear in the CC field.
from_address read only	string	The address showing the email sender.
html_body read only	string	The email HTML body.
name read only	string	The name of the email template.
subject read only	string	The email subject title.
template_sid read only	string	The email template secure ID.
text_body read only	string	The email text body.
to_addresses read only	string	The addresses of the recipients.
type read only	string	The email template type. Values accepted in this field are: email_address_verification for the template used for email verification. email_partner_review for the template used to review partners. forgot_partner_password for the template used to reset the forgotten password. invoice for the invoice template. low_balance_partner_notification for the template used to notify of a low balance. new_partner_welcome for the welcome email message template. suspended_partner_notification for the template used to notify the partner about suspension from access to CarrierX services.

Sample Email Template Object

{
    "bcc_addresses": "jsmith@freeconferencecall.com",
    "cc_addresses": null,
    "from_address": "noreply@carrierx.com",
    "html_body": "",
    "name": "Forgot Partner Password template",
    "subject": "QA: CarrierX Password Reset",
    "template_sid": "465eb46b-05a7-4251-b89c-e99f2b81509b",
    "text_body": "To complete your password reset, please click the link below:\n${base_url}?token=${uuid}\n\nYou are receiving this email because someone has initiated a password reset on\nyour account.\n\n4300 E. Pacific Coast Highway | Long Beach, CA | 90804\n",
    "to_addresses": null,
    "type": "forgot_partner_password"
}