Create

Create

Use this endpoint to customize the emails sent to your recipients for completing a W-9/W-8 form, or requesting e-sign via Form 8453-EMP, with your own branding.

• Your request JSON can include sender name, email address, support details and branding elements such as the business logo and color theme.

• If you prefer to use the Advanced customization option (fully customized email address with your own domain), you must set the IsAdvanceCustomization node as TRUE.

Note:

If you choose the Advanced option, you’ll be prompted to verify the email address through a secure link. Until the verification is complete, the default email address (support@<Business Name>.taxbandits.com) will be used on the emails.

POST EmailCustomization/Create 

Run in Postman

Request Body

Field	Type	Description
BusinessLogoURL	Guid	If given, the business logo will be displayed in the email  Size Range: ..150
PrimaryColor	string	Optional The color theme of the email will be customized with this primary color Note: Only HexCode color values are allowed
IsAdvanceCustomization	boolean	If set to true, advanced customization is enabled, allowing the entire email address to be customized with your own domain in the SenderEmail node  If set to false, only the domain name of the email address can be customized
CustomizationDetails	object	The sender details to be shown in the email
SenderName	string	The sender name to be shown in the email Size Range: ..35
SenderEmail	string	The sender email address to be shown in the email Size Range: ..100
SupportDetails	object	The support details to be shown in the email
PhoneNumber	string	The support phone number to be shown in the email
Email	string	Optional The support email address to be shown in the email Note: The email address of the business will be shown by default if the support email is not given Size Range: ..100

Response Body

Field	Type	Description
EmailCustomizationId	Guid	A unique customization identifier generated by TaxBandits. You can use this ID in your RequestByEmail method
EmailCustomizationNm	string	A unique customization name generated by TaxBandits
EmailStatus	string	Verification status of email
Errors	object[]	Collection of errors
Id	string	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	string	Name of the errored node.
Message	string	Shows the error message

Request JSON

Request JSON

{
  "BusinessLogoURL": "https://www.spanenterprises.com/Content/Images/span.png",
  "PrimaryColor": "#FFFFFF",
  "IsAdvanceCustomization": true,
  "CustomizationDetails": {
    "SenderName": "SnowDaze",
    "SenderEmail": "Sample@gmail.com"
  },
  "SupportDetails": {
    "PhoneNumber": "1234567890",
    "Email": "Sample@gmail.com"
  }
}

Response JSON

{
    "EmailCustomizationId": "c79327c2-0d3d-4510-83a7-0b78bb32d3c0",
    "EmailCustomizationNm": "Customization 01",
    "EmailStatus": "VERIFIED",
    "Errors": null
}