API Reference

Create a new note

post
https://integrate.rooflink.com/roof_link_endpoints/api/light/notes/

Creates a new note in the system. Notes are associated with jobs and may sent to multiple recipients. Following a successful create request the system will send the note to the configured recipients asynchronously.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Note creation request containing message, recipients, tags, and job association details.

string
required

The content of the note. This field is required and contains the main message text that will be sent to recipients.

tags
array of strings | null

Array of tag strings to categorize the note. Available tags are defined in the company settings under 'job_note_tags'. This field may be required based on company settings (tag_required_on_job_notes), and is ignored if the note is created by a crew user.

tags
boolean
Defaults to false

If true, adds the job's customer representative to the recipients list automatically. This field is ignored if the note is created by a crew user.

boolean
Defaults to false

If true, sends the note via email to the customer. This field is ignored if the note is created by a crew user.

recipients
array of integers | null

Array of user IDs to receive the note. Recipients are users who will be notified about this note. This field may be required based on company settings (recipients_required_on_job_notes). For crew users, the job's customer rep, secondary rep, and project manager are automatically added as recipients.

recipients
integer
required

The ID of the job this note is associated with. This field is required and must reference a valid job in the system.

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago