NetworkActionDetails

  • Type-specific details for a network action. For type="note", the value is a note details object. For type="audit", the value is an audit details object.

    Details for note actions

    • kind
      Discriminator
      enum
      const:  
      note
      required
      values
      • note
    • archivedAt
      Type: null | stringFormat: date-time

      When this note was archived (UTC, ISO 8601). Null when the note is still active. Populated for archived rows and for predecessors in a supersede chain (a superseded predecessor is also archived in the same transaction). Only returned when include_archived=true is requested, since archived rows are hidden from the default action list response.

    • file
      Type: object · FileAttachment nullable

      Attached file information (if any)

    • idempotencyKey
      Type: null | string

      Idempotency key used when creating this note (if applicable)

    • message
      Type: string

      The note text content

    • noteType
      Type: null | string

      Activity sub-type: "call", "meeting", "email", "news". Null for plain notes.

    • oauthClientId
      Type: null | string

      OAuth client ID that created this note (if created via Public API)

    • supersededByActivityId
      Type: null | string

      Id of the successor note that supersedes this note (i.e., this note is the predecessor and has been replaced by a newer revision). Null when this note is still the active head of its chain. Only meaningful when the predecessor is returned, which requires include_archived=true or include_superseded=true.

    • supersedesActivityId
      Type: null | string

      Id of the predecessor note that this note supersedes (i.e., this note is the successor / current revision in a supersede chain). Null when this note is the original (not a revision of any other note).

Propstreet API Documentation