Skip to main content

Customer Managed SendGrid

Base Configuration​

ConfigurationInherits from Primary?Data TypeDescription
API_KEYtrueSG.[a-zA-Z0-9.-]{32}The SendGrid API Key that has Send Mail API access. Usually there is just one API key for the space and sub brands inherit from the primary brand.
FROM_ADDRESStrueemailThe email address that the emails should be sent from (e.g., cdr@exampleholder.com). See note below.
notificationLongDateFormattruestringThe date format used for expiry dates in sharing request notification types.
notificationShortDateFormattruestringThe date format used for sharing events and secondary user instructions in periodic summary notification types.
info

The from address must be setup in SendGrid before you can send emails with it, as sending emails from SendGrid without the proper DNS records will result in the emails being rejected as spam by your customer's email providers.

Template IDs​

ConfigurationInherits from Primary?Data TypeDescription
ARRANGEMENT_ACTIONtrued-[a-f0-9]{32}Required if supporting Secondary Users or Joint Accounts. The template ID for the ARRANGEMENT_ACTION event.
SHARING_DISABLEDtrued-[a-f0-9]{32}Required if supporting Joint Accounts. The template ID for the SHARING_DISABLED event.
SHARING_REQUESTEDtrued-[a-f0-9]{32}Required if supporting Joint Accounts. The template ID for the SHARING_REQUESTED event.
SHARING_REQUEST_ACTION_ONEtrued-[a-f0-9]{32}Required if supporting Joint Accounts. The template ID for the SHARING_REQUEST_ACTION_ONE event.
SHARING_REQUEST_COMPLETEtrued-[a-f0-9]{32}Required if supporting Joint Accounts. The template ID for the SHARING_REQUEST_COMPLETE event.
SECONDARY_USER_INSTRUCTION_ACTIONtrued-[a-f0-9]{32}Required if supporting Secondary Users. The template ID for the SECONDARY_USER_INSTRUCTION_ACTION event.
OTP_TEMPLATE_IDtrued-[a-f0-9]{32}Required if using Biza Managed OTP and Email OTPs. The template ID for the OTP event
PERIODIC_SUMMARYtrued-[a-f0-9]{32}Required if supporting Secondary Users or Joint Accounts. The template ID for the PERIODIC_SUMMARY event.