Type Alias NoteRaw

NoteRaw: {
    associated_person_ids: number[];
    content: string;
    created_at: DateTime;
    creator_id: number;
    id: number;
    interaction_id: number | null;
    interaction_person_ids: number[];
    interaction_type: number | null;
    is_meeting: boolean;
    mentioned_person_ids: number[];
    opportunity_ids: number[];
    organization_ids: number[];
    parent_id: number | null;
    person_ids: number[];
    type: NoteType;
    updated_at: DateTime | null;
}

A note object contains content, which is a string containing the note body. In addition, a note can be associated with multiple people, organizations, or opportunities. Each person, organization, or opportunity will display linked notes on their profiles.

Type declaration

  • associated_person_ids: number[]

    An array containing the unique identifiers for the persons directly associated with the note.

  • content: string

    The string containing the content of the note.

  • created_at: DateTime

    The string representing the time when the note was created.

  • creator_id: number

    The unique identifier of the person object who created the note.

  • id: number

    The unique identifier of the note object.

  • interaction_id: number | null

    The unique identifier of the interaction the note is attached to, if any.

  • interaction_person_ids: number[]

    An array containing the unique identifiers for the persons on the interaction the note is attached to, if any. This will be an empty array if there is no such interaction or there aren’t any attendees.

  • interaction_type: number | null

    The type of the interaction the note is attached to, if any.

  • is_meeting: boolean

    True if the note is attached to a meeting or a call.

  • mentioned_person_ids: number[]

    An array containing the unique identifiers for the persons who are @ mentioned in the note. If there are no mentioned persons, this will be an empty array.

  • opportunity_ids: number[]

    An array of unique identifiers of opportunity objects that are associated with the note.

  • organization_ids: number[]

    An array of unique identifiers of organization objects that are associated with the note.

  • parent_id: number | null

    The unique identifier of the note that this note is a reply to. If this field is null, the note is not a reply. Note replies will never have values for opportunity_ids, person_ids, and organization_ids. Only the parent note is associated with an entity. You can fetch the parent note resource to identify the root entity.

  • person_ids: number[]

    An array containing the unique identifiers for all the persons relevant to the note. This is the union of Note.associated_person_ids and Note.interaction_person_ids.

  • type: NoteType

    The type of the note.

  • updated_at: DateTime | null

    The string representing the last time the note was updated.

Settings

Member Visibility