Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Subcontractors Agreement Notes Relation Api → Patch Api Contractors Subcontractors Agreements Subcontractors Agreement Notes Note

AI-generated

Summary

Update fields of an existing note related to a subcontractors agreement by providing its ID and the subcontractors agreement ID, modifying any supplied fields except those left as "DO_NOT_UPDATE".

Inputs

  • Subcontractors Agreement (required) — The ID of the subcontractors agreement to which the note belongs.
  • Note (required) — The ID of the note to update.
  • Title — The new title of the note. Leave as "DO_NOT_UPDATE" to not change.
  • Note — The content text of the note. Leave as "DO_NOT_UPDATE" to not change.
  • Files — A JSON array of attachments for the note, either uploaded files or base64-encoded strings. Leave as "DO_NOT_UPDATE" to not change attachments.
  • Permission — Integer representing note visibility: 1 (public), 2 (public read-only), or 3 (private). Leave as "DO_NOT_UPDATE" to not change.
  • Sticky — Flag or value marking note as sticky. Leave as "DO_NOT_UPDATE" to not change.
  • Category Id — Category identifier string for the note. Leave as "DO_NOT_UPDATE" to not change.
  • Alert — Alert text or data associated with the note. Leave as "DO_NOT_UPDATE" to not change.
  • Alert Grid — Alert grid data associated with the note. Leave as "DO_NOT_UPDATE" to not change.
  • Alert To — Recipient information for alerts. Leave as "DO_NOT_UPDATE" to not change.
  • Alert Type — Type of alert. Leave as "DO_NOT_UPDATE" to not change.
  • External Id — External system identifier for the note. Leave as "DO_NOT_UPDATE" to not change.

Output shape

a single JSON object representing the updated note.

The operation patches only the fields provided and ignores those set to sentinel values ("DO_NOT_UPDATE" or "DO_NOT_SET"). The request requires specifying both the subcontractors agreement ID and note ID.

Examples

Example 1: Update the title and note content fields of a specific note

Set Subcontractors Agreement ID, Note ID, Title with new string, Note with new string, and leave other fields as "DO_NOT_UPDATE".

Links

Discussion