Skip to content
Installer.com logo

Create order notes via API

You can add a note to an order from an external system using the Installer.com API. A note carries plain text, can have files attached, and can be kept internal to your own organisation or shared with the other organisations on the order.

Before you begin

  • Generate an API key. For details, see Generate an API key.
  • Send the key as a bearer token in the Authorization header on every request.

Upload files first

Skip this section if the note is text only.

  1. Send a POST request to /api/v1/file/upload with the file in a multipart/form-data field named file.
  2. Read the value field from the response. That is the file id.
  3. Repeat for each file you want to attach.

Create the note

Send a POST request to /api/v1/order/{orderId}/note, where orderId is the id of the order.

Field Type Required Notes
content string Yes The text of the note. Cannot be empty.
fileIds array of strings No File ids from /api/v1/file/upload.
isPublic boolean No Defaults to false.

Set isPublic to true to make the note visible to the other organisations on the order. Leave it out, or set it to false, to keep the note visible only to your own organisation.

A successful request returns 201 Created with the note’s id, orderId, content, fileIds, isPublic and createdAt.

When it goes wrong

  • One or more fileIds were not found: a file id in fileIds does not exist. Upload the file again and use the id from that response.

Need help? Contact Installer.com support.

Was this helpful?