Create a note for a specific installation

post

https://enerflo.io/api/v3/installs/{id}/notes

Path Params

integer

required

The ID of the installation.

Body Params

note

string

required

The text content of the note.

customer_facing

integer

enum

If 0 or null, then this note will NOT be visible to the customer in the customer portal. If 1, the customer will be able to see this note in the customer portal.

Allowed:

milestone_id

integer

milestone_id is an optional field. It is the Enerflo system ID automatically generated when a milestone is created by the Installer. Installers can see their milestone_id values here. When provided to this endpoint, the milestone_id associates the note with the milestone stage in the Enerflo UI. It offers additional granularity for categorizing notes.

file

The binary content of the file. This is an optional field. If provided, the file will be attached to the note being created.

created_at

date-time

This is a UTC datetime value. Values should be provided in the following format: "yyyy-mm-dd mm:hh:ss". Example: '2024-06-06 00:00:00'. If null or not provided then the value will be defaulted to now().

skip_webhooks

integer

enum

Defaults to 1

If 1 then downstream webhook events WILL NOT BE triggered by this update. If 0 or not provided, then downstream webhook events WILL BE triggered.

Allowed:

Responses

200

Note created successfully

401

Unauthorized

404

Install not found

500

Internal Server Error

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!