The Report Templates API gives you access to manage your organization's report templates programmatically.

Properties

Property	Type	Required	Readonly	Description
name	string	yes	no	The name of the report templates.
description	string	no	no	The description of the report template.
body	string	yes	no	The body of the report template.
header	string	yes	no	The header of the report template.
footer	string	yes	no	The footer of the report template.
styles	string	yes	no	The styles of the report template.
script	string	yes	no	The script of the report template.
config	string	no	no	The config of the report template.
status	string	yes	no	The status of the report template. Valid values are active and inactive.
type	string	yes	no	The type of the report template. Valid values are advanced and basic.
id	string	no	yes	The id of the webhook.
created_by	string	no	yes	The user who created the report template.
created_by_id	string	no	yes	The user_id of the user who created the report template.
updated_by	string	no	yes	The user who last updated the report template.
updated_by_id	string	no	yes	The user_id of the user who last updated the report template.
created_at	string	no	yes	Timestamp when the report template was created.
updated_at	string	no	yes	Timestamp when the report template was last updated.

Validations

The following properties must be included in order to create/update a report template object in our system. Any validation errors will return a 422 and an object with a list of validation errors.

Required Properties

Property	Type	Description	Example
name	string	The name of the report template.	`"Fire Hydrant Report"`
status	string	The status of the report template.	`"active"`
type	string	The type of the report template.	`"advanced"`