Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Change Order Notes Relation Api → Post Api Contractors Change Orders Change Order Notes

AI-generated

Summary

Posts a note (with optional attachments and metadata) to a specific change order via the Contractors.es Change Order Notes Relation API.

Inputs

  • change_order (required) — ID of the change order to which the note will be attached. Must be a number.
  • title — Title of the note. Provide a string or leave as DO_NOT_SET to omit.
  • note — Body content of the note. Provide a string or leave as DO_NOT_SET to omit.
  • files — Array of file attachments. Each entry can be a form‑data upload or a base64 string (raw, data:mime;base64,…, or name=filename;base64,…). Provide JSON or leave as DO_NOT_SET to omit.
  • permission — Visibility of the note. Options: 1 = public, 2 = public (read‑only), 3 = private, or DO_NOT_SET to omit.
  • sticky — Flag to make the note sticky. Provide a string or leave as DO_NOT_SET to omit.
  • category_id — Category identifier for the note. Provide a string or leave as DO_NOT_SET to omit.
  • alert — Alert message associated with the note. Provide a string or leave as DO_NOT_SET to omit.
  • alert_grid — Grid‑based alert indicator. Provide a string or leave as DO_NOT_SET to omit.
  • alert_to — Recipient(s) for the alert. Provide a string or leave as DO_NOT_SET to omit.
  • alert_type — Type of alert (e.g., email, sms). Provide a string or leave as DO_NOT_SET to omit.
  • external_id — External identifier for the note. Provide a string or leave as DO_NOT_SET to omit.
  • requestOptions — Advanced HTTP settings: batching (items per batch and interval), proxy, timeout, and SSL verification.

Output shape

object

Returns the raw API response for the created note, typically JSON containing the note’s ID, attached files, timestamps, and any fields echoed back by the Contractors.es service.

Examples

Example 1: Add a simple note to change order 123

Set change_order = 123, note = 'Materials delayed', title = 'Delay notice', leave other fields at DO_NOT_SET.

Example 2: Attach files and set visibility

Provide change_order, note, files array with base64 payloads, permission = 2 (public read‑only), and optionally sticky = 'yes'.

Links

Discussion