Pearl Certification Developer Documentation

Maintenance Templates

Pearl gives you the ability to set up maintenance templates for your customers in Green Door. This is a great way to stay in front of your customers all year long and have your customers coming back to you when they have regular scheduled maintenance.

Assign a maintenance template to a home

To assign maintenance templates to homes via the API you must first set up one or more maintenance templates through the Cert App UI. This guide assumes a maintenance template has already been set up. Also, if a maintenance template has been set up as the default template it means it is automatically assigned to a new home and does not need to be assigned via the API.

  1. Retrieve the currently configured maintenance templates using the /maintenance_templates/ endpoint. This endpoint returns the details on each maintenance template including the maintenance template ID which will be needed to assign a template to a home.
  2. To assign a maintenance template to a home use the /homes/{home_id}/assigned_maintenance_templates/ endpoint. One or more maintenance templates can be assigned to a home leveraging this endpoint.