Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Job Visit Notes Relation Api → Patch Api Contractors Job Visits Job Visit Notes Note

AI-generated

Summary

Updates a specific job visit note on Contractors.es using a PATCH request, allowing selective field updates.

Inputs

  • job_visit (required) — The ID of the job visit associated with the note to update.
  • note (required) — The ID of the note to update.
  • title — New note title. Set to 'DO_NOT_UPDATE' or 'DO_NOT_SET' to preserve the existing value.
  • note — New note text content. Set to 'DO_NOT_UPDATE' or 'DO_NOT_SET' to preserve the existing value.
  • files — Array of attachments. Can be form-data uploads or base64 strings. Set to 'DO_NOT_UPDATE' or 'DO_NOT_SET' to preserve existing files.
  • permission — Visibility level: 1 (public), 2 (read-only), 3 (private). Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • sticky — Whether the note is pinned/sticky. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • category_id — The ID of the note category. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • alert — Alert setting. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • alert_grid — Alert grid setting. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • alert_to — Recipient of alerts. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • alert_type — Type of alert. Set to 'DO_NOT_UPDATE' to preserve the current setting.
  • external_id — External identifier. Set to 'DO_NOT_UPDATE' to preserve the current setting.

Output shape

The updated note record from the Contractors.es API.

If the PATCH is successful, the response body is returned as an item. The API response structure is defined in the node's OpenAPI documentation (referenced in the source code).

Examples

Example 1: Update note title only

Set job_visit and note IDs to required values. Set title to a new string. Set other optional fields (note, files, etc.) to 'DO_NOT_UPDATE' to preserve existing data.

Example 2: Update multiple fields

Set job_visit and note IDs. Provide new values for title, permission (1/2/3), and sticky. Set other fields to 'DO_NOT_UPDATE'.

Links

Discussion