Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Subcontractors Agreement Notes Relation Api → Post Api Contractors Subcontractors Agreements Subcontractors Agreement Notes

AI-generated

Summary

Create a new note related to a subcontractors agreement by sending details such as title, note content, attachments, permissions, and alert settings to the Contractors.es API.

Inputs

  • subcontractors_agreement (required) — The ID of the subcontractors agreement to associate the note with (number).
  • title — The title of the note (string). Defaults to not set if omitted or set to 'DO_NOT_SET'.
  • note — The content of the note (string). Defaults to not set if omitted or set to 'DO_NOT_SET'.
  • files — A JSON array of note attachments, which can include form-data upload files or base64 encoded payloads with supported formats.
  • permission — The permission setting for the note (options: 1 - public, 2 - public read-only, 3 - private). Defaults to not set if omitted.
  • sticky — Sticky attribute for the note (string).
  • category_id — Category ID for the note (string).
  • alert — Alert configuration string for the note.
  • alert_grid — Alert grid configuration string.
  • alert_to — Recipient(s) of alert notifications (string).
  • alert_type — Type of alert (string).
  • external_id — An external identifier for the note (string).

Output shape

a single record containing the created subcontractors agreement note data as returned by the API

Optional fields can be omitted by setting them to the sentinel value 'DO_NOT_SET'. The API request is sent as JSON body with only provided fields included. Attachments can be uploaded as files or base64 payloads. The operation returns the API response for the created note.

Links

Discussion