Deprecation: Header and Footer Attributes in the Notification Template APIs

Announcements Product News
, , ,
1

Notice of Field Deprecation For Notification Template APIs

header and footer fields of the /beta/notification-templates and /beta/notification-template-defaults APIs is being deprecated. The reason for deprecation is that they don’t serve a useful purpose within the product UI and we are simplifying the template schema to just have a body attribute incorporating header and footer values within it.

Guidance

header and footer field values for /beta/notification-template-defaults and /beta/notification-templates resources will be moved into respective positions within the body field. These fields will no longer be available for reading or writing. The formatting of your email notifications will not be affected.

  • Example header value: “Dear $__recipient.name,"
  • Example footer value: “Thanks, The $__global.productName Team"

The following templates will be impacted by this change

key name
work_reassignment_updated Work Reassignment Updated
work_reassignment_created Work Reassignment Created
campaign_template_pregen_notification Campaign Template Pre-Generation Notification
non_employee_bulk_import_passed_email_notification Non-Employee Account Upload Succeeded
non_employee_bulk_import_failed_email_notification Non-Employee Account Upload Failed
non_employee_term_end_date_near Non-Employee Term End Date Near
non_employee_request_action_completed Non-Employee Request Action Completed
non_employee_approval_required Non-Employee Approval Required
non_employee_request_created Non-Employee Request Created
cloud_manual_work_item_summary Task Manager Subscription
2

Hi @colin_mckibben

Will the default header and footer field values be eliminated?

For instance, the header value: "Dear $__recipient.name,"
And the footer value: "Thanks, The $__global.productName Team"

Is there an API available to modify or remove these header and footer components?

I’m currently in the process of rebranding the notification templates to support NELM solution.

Thanks

3

Welcome to the Developer Community @thiruppathit .

Whatever contents were in the header and footer fields will be moved to the body once the deprecation is finalized, and then they can be updated directly in the body.

Until the deprecation occurs, you can either continue to modify the header and footer and your updates will be persisted in the body after the deprecation, or you can put null values in for those fields and add the header and footer directly to the body.

4

Is there an ETA on this depreciation?

When I create a notification template for work_reassignment_created via /beta/notification-templates, I can set null for footer and header. But when I create a reassignment, no notifications are sent. If I go in and modify the template via the UI, just saving the existing body, it resets the default values for footer and header. Emails are then sent. Appears that the emails only send if there is a value?

5

I’ve been advised that it’s actually better to just keep using the header and footer attributes for now until the deprecation is complete. Don’t null them out at this time.