Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Inventory Stocktaking Notes Relation Api → Patch Api Assets Inventory Stocktakings Inventory Stocktaking Notes Note

AI-generated

Summary

Update specified fields of a note related to an inventory stocktaking by applying a PATCH request using the Inventory Stocktaking and Note IDs.

Inputs

  • Inventory Stocktaking (required) — The numeric ID of the inventory stocktaking to which the note belongs.
  • Note (required) — The numeric ID of the note to update.
  • Title — The new title for the note; omit or use sentinel value to leave unchanged.
  • Note — The new content/body text of the note; omit or use sentinel value to leave unchanged.
  • Files — An array of attachments for the note, which can be form-data files or base64-encoded strings; omit or use sentinel value to leave unchanged.
  • Permission — Permission level for the note, where 1 = public, 2 = public read-only, 3 = private; omit or use sentinel value to leave unchanged.
  • Sticky — Indicates if the note is sticky; omit or use sentinel value to leave unchanged.
  • Category Id — Category identifier to classify the note; omit or use sentinel value to leave unchanged.
  • Alert — Alert text associated with the note; omit or use sentinel value to leave unchanged.
  • Alert Grid — Grid alert configuration for the note; omit or use sentinel value to leave unchanged.
  • Alert To — Specifies recipients of alerts related to the note; omit or use sentinel value to leave unchanged.
  • Alert Type — Type of alert associated with the note; omit or use sentinel value to leave unchanged.
  • External Id — External identifier for referencing the note; omit or use sentinel value to leave unchanged.

Output shape

a single updated note record

Returns the updated note object reflecting the applied changes. Only the fields specified and not set to sentinel values are changed; others remain unchanged. Fields set to the special sentinel values 'DO_NOT_UPDATE' or 'DO_NOT_SET' are omitted from the update payload.

Links

Discussion