ActionDetails

  • Type-specific payload for an action. Discriminated by kind — which mirrors the row's top-level type: note carries a note details object; chat carries a conversation details object (a shared file, if any — the message body itself is private and never returned); audit carries an immutable event details object. A row's origin is conveyed separately by the action's subject field, not by adding new kinds.

    Details for a note action (kind = note).

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

      When this note was archived (UTC, ISO 8601). Null when active. Populated for archived rows and for superseded predecessors. Only returned when include_archived=true is requested.

    • contentFormat
      Type: null | string

      Rendering format of the note body: markdown for markdown notes; null for plain text.

    • file
      Type: object · FileAttachment nullable

      Attached file information, if any.

    • message
      Type: string

      The note text content.

    • noteType
      Type: null | string

      Activity sub-type: call, meeting, email, news. Null for plain notes and for surfaces that carry no sub-type.

    • supersededByActivityId
      Type: null | string

      Id of the successor note that supersedes this note. Null when this note is the active head of its chain.

    • supersedesActivityId
      Type: null | string

      Id of the predecessor note this note supersedes (this note is the current revision). Null when this note is the original.