PatchProspectNoteRequest

Body for PATCH /api/v1/projects/{projectId}/prospects/{id}/notes/{noteId}. Body-discriminated: action selects archive / unarchive / supersede; the supersede object carries the new-revision payload when applicable and is ignored for archive / unarchive.

  • action
    Type: string
    required

    Required verb. One of: archive, unarchive, supersede. Unknown values return 400 ValidationFailed.

  • supersede
    Type: object ยท SupersedeNotePublicRequest nullable

    Required when action == "supersede"; ignored otherwise. Every field is a partial-update wrapper: omitted properties inherit from the predecessor, and explicit null clears the field.

    • contentFormat
      Type: null | string

      New content format for the note body. Accepts the case-insensitive strings plaintext or markdown. Omitted = inherit predecessor's format. Explicit null clears the format (renders as plain text). Applies to all note types (contact, company, prospect, and project notes).

    • fileId
      Type: null | string

      New file attachment id. Omitted = inherit. Explicit null = clear. Must reference a file owned by the authenticated user when specified.

    • message
      Type: null | string

      New message text. Omitted = inherit predecessor's message. Explicit null = clear. 1-10000 characters when supplied with a non-null value (length is validated at handler time rather than by data-annotations because of the partial-update wrapper).