Skip to content
Last updated

Using communication templates from the API

Once a communication template has been created and enabled through the admin UI, you reference it by its identifier in your API submission requests. The platform replaces the default system template with the custom one and resolves any variables declared in the template at send time.

For how to create and manage templates, see Communication templates.

EviNotice

EviNotice template parameters are set at the top level of the submit request body.

Template parameters

ParameterDescription
NotificationTemplateIdentifier of the enabled EviNotice:Email:Notification template to use for the recipient's notification email.
NotificationTemplateValuesKey-value pairs supplying values for the user variables declared in the notification template.
OwnerNotificationTemplateIdentifier of the enabled EviNotice:Email:OwnerNotification template to use for the issuer's status notification email.
OwnerNotificationTemplateValuesKey-value pairs supplying values for the user variables declared in the owner notification template.

EviNotice example

POST /v2/EviNotice/Submit HTTP/1.1
Host: api.evicertia.com
Authorization: Basic <base64(username:password)>
Content-Type: application/json

{
  "Subject": "Your insurance policy update",
  "Body": "Please review the attached update to your insurance policy.",
  "RecipientAddress": "recipient@example.com",
  "RecipientLegalName": "Jane Smith",
  "IssuerLegalName": "Acme Insurance",
  "CertificationLevel": "Advanced_EU",
  "NotificationTemplate": "acme-notice-en",
  "NotificationTemplateValues": {
    "policyNumber": "POL-2025-00123",
    "renewalDate": "2025-06-30"
  },
  "OwnerNotificationTemplate": "acme-owner-notice-en",
  "OwnerNotificationTemplateValues": {
    "policyNumber": "POL-2025-00123"
  }
}

Affidavit side effects

When NotificationTemplate is set and CertificationLevel is not None, the platform automatically generates the EviNoticeDispatched affidavit regardless of whether it was requested in AffidavitKinds.

Templates in batch sending

The EviNotice, EviMail, and EviSMS batch APIs accept OwnerNotificationTemplate on the batch PATCH request, applying the issuer status-notification template across the batch. The recipient-facing NotificationTemplate is not a batch field — batch content is set with the batch Body endpoint (or, for EviSMS, the Text field) rather than a recipient notification template.

Template values format

The *TemplateValues parameters accept a flat key-value object where each key matches a user variable declared in the template and each value is the string to substitute at send time.

"NotificationTemplateValues": {
  "policyNumber": "POL-2025-00123",
  "renewalDate": "2025-06-30"
}

Variable names must match exactly what was declared during template creation. Variables marked as required in the template must be supplied in every request that references that template.