Email attachment password.

Ignored if templateName is not provided or the specified template cannot be found.

Effect: Encrypts the attachment generated by the template specified in templateName. The recipient will need this password to open the attachment.

Note:

• Omitting this parameter or leaving it blank will result in sending an unencrypted attachment.
• Currently, only attachments that are automatically generated by a template are supported; arbitrary file attachments are not.

Optional email service provider.

Ignored if emailSendMethod != “API”.

Effect: The email will be sent via the corresponding provider, if it exists and is configured for the sending financial institution.

If omitted: The email will be sent via the first available provider configured for the sending financial institution.

Valid value: An error (400 status code) will be returned if emailSendMethod = “API” and this parameter is:

• specified, but the provider with the specified name does not exist or is not configured for the sending financial institution;
• not specified, and no provider is configured for the sending financial institution or none of the configured providers is available.

A required field specifying the method for sending the email.

• “SMTP” – send via a direct SMTP server connection.
• “API” – send via a pre-configured third-party service provider (e.g., SendGrid).

Preferred language for the email.

Ignored if no templateName is specified.

Effect: Prepends the templateName with the specified language code.

Example: templateName = “welcome-template” and language = “en” will match “en-welcome-template.html” file.

Valid value: Two-letter ISO 639-1 language code (e.g., “en”).

Fallback: If a template with the specified name is not found, the email will be composed using text and subject parameters.

Recipient email address. For multiple recipients can be provided as comma-separated email addresses.

Optional SMTP provider name.

Ignored if emailSendMethod != “SMTP”.

Effect: The email will be sent via the corresponding provider, if it exists and is configured for the sending financial institution.

If omitted: The email will be sent via the first available SMTP service provider configured for the sending financial institution.

Valid value: An error (400 status code) will be returned if emailSendMethod = “SMTP” and this parameter is:

• specified, but the provider with the specified name does not exist or is not configured for the sending financial institution;
• not specified, and no provider is configured for the sending financial institution or none of the configured providers is available.

The subject line for the email.

Effect: Used as the email subject when a template is either:

• not specified in templateName
• cannot be found
• does not contain a <subject> tag

Valid value: 78 or fewer characters.

Note: If a subject is provided neither here nor in the template, the default subject “Notification Email” will be used.

Name of the email template to use.

Effect: The email will be composed using the specified template populated with the placeholders parameter values.

Valid value: Must match the name of a pre-defined .html file.

Example: templateName = “welcome-template” will match “welcome-template.html” file.

Fallback: If a template with the specified name is not found, the email will be composed using text and subject parameters.

Note: Templates are managed in the NI API Center. There is currently no self-service API or UI for adding or updating them.

The plain text content for the email body.

Effect: Used as the email body when a template is not specified in templateName.

Valid value: 10000 or fewer characters.

Note: Can be provided as a Base64-encoded string, which will be automatically decoded before sending.

The W3C Trace Context traceparent header for distributed tracing.
It helps propagate trace information across services.
For more details, refer to the official Trace Context documentation.