Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Task Notes Relation Api → Patch Api Crm Tasks Task Notes Note

AI-generated

Summary

Patch an existing note associated with a specific task by providing its task ID and note ID, optionally updating various fields such as title, note content, attachments, permissions, and alert settings.

Inputs

  • task (required) — Numeric ID of the task to which the note belongs.
  • note (required) — Numeric ID of the note to update on the specified task.
  • title — New title for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • note — New content for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • files — JSON array of attachments for the note. Supports form-data file uploads or base64-encoded payload strings. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • permission — Permission level for the note: 1 (public), 2 (public read-only), 3 (private). Set to 'DO_NOT_UPDATE' to leave unchanged.
  • sticky — Sticky flag for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • category_id — Category identifier for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • alert — Alert text associated with the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • alert_grid — Alert grid setting for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • alert_to — Alert recipient for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • alert_type — Type of alert for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.
  • external_id — External identifier for the note. Set to 'DO_NOT_UPDATE' to leave unchanged.

Output shape

a single updated note record

Only fields provided and not set to 'DO_NOT_UPDATE' are patched; fields with 'DO_NOT_UPDATE' sentinel values are omitted to keep their current values. The operation requires both task and note IDs as input.

Examples

Example 1: Update note content and title while leaving other fields unchanged

Set 'task' and 'note' IDs, specify new 'title' and 'note' text, leave other optional fields as default 'DO_NOT_UPDATE'.

Links

Discussion