nodes/generated

Interface MonicaCrmNodeParameters

Source
interface MonicaCrmNodeParameters {
    activityId?: string;
    activityTypeId?: string;
    additionalFields?:
        | { description?: string }
        | {
            birthdate?: string;
            deceasedDate?: string;
            is_partial?: boolean;
            isDeceased?: boolean;
            last_name?: string;
            nickname?: string;
        }
        | { isFavorited?: boolean };
    body?: string;
    calledAt?: string;
    callId?: string;
    contactFieldId?: string;
    contactFieldTypeId?: string;
    contactId?: string;
    contacts?: string;
    content?: string;
    conversationId?: string;
    data?: string;
    filters?: {
        query?: string;
        sort?:
            | "updated_at"
            | "created_at"
            | "-created_at"
            | "-updated_at";
    };
    firstName?: string;
    frequencyNumber?: number;
    frequencyType?: "week"
    | "month"
    | "year"
    | "one_time";
    genderId?: string;
    happenedAt?: string;
    initialDate?: string;
    journalId?: string;
    limit?: number;
    messageId?: string;
    name?: string;
    noteId?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete";
    post?: string;
    reminderId?: string;
    resource?: | "tag"
    | "contact"
    | "contactTag"
    | "task"
    | "note"
    | "call"
    | "conversation"
    | "activity"
    | "contactField"
    | "conversationMessage"
    | "journalEntry"
    | "reminder";
    returnAll?: boolean;
    summary?: string;
    tagId?: string;
    tagsToAdd?: unknown[];
    tagsToRemove?: unknown[];
    taskId?: string;
    title?: string;
    updateFields?: | {
        activity_type_id?: string;
        contacts?: string;
        description?: string;
        happened_at?: string;
        summary?: string;
    }
    | {
        calledAt?: string;
        contactId?: string;
        content?: string;
    }
    | {
        birthdate?: string;
        deceased_date?: string;
        first_name?: string;
        gender_id?: string;
        is_deceased?: boolean;
        is_partial?: boolean;
        last_name?: string;
        nickname?: string;
    }
    | {
        contact_id?: string;
        content?: string;
        written_at?: string;
        written_by_me?: boolean;
    }
    | { post?: string; title?: string }
    | {
        body?: string;
        contact_id?: string;
        is_favorited?: boolean;
    }
    | {
        contact_id?: string;
        description?: string;
        frequency_number?: number;
        frequency_type?: | "week"
        | "month"
        | "year"
        | "one_time";
        initial_data?: string;
        title?: string;
    }
    | {
        completed?: boolean;
        contactId?: string;
        description?: string;
        title?: string;
    };
    writtenAt?: string;
    writtenByMe?: boolean;
}

Properties§

§readonly activityId?: string

ID of the activity to delete

§readonly activityTypeId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getActivityTypes"}

§readonly additionalFields?:
    | { description?: string }
    | {
        birthdate?: string;
        deceasedDate?: string;
        is_partial?: boolean;
        isDeceased?: boolean;
        last_name?: string;
        nickname?: string;
    }
    | { isFavorited?: boolean }

Default: {}

§readonly body?: string

Body of the note - max 100,000 characters

§readonly calledAt?: string

Date when the call happened

§readonly callId?: string

ID of the call to delete

§readonly contactFieldId?: string

ID of the contactField to delete

§readonly contactFieldTypeId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getContactFieldTypes"}

§readonly contactId?: string

ID of the contact to associate the call with

§readonly contacts?: string

Comma-separated list of IDs of the contacts to associate the activity with

§readonly content?: string

Description of the call - max 100,000 characters

§readonly conversationId?: string

ID of the conversation to delete

§readonly data?: string

Content of the contact field - max 255 characters

§readonly filters?: { ... }

Default: {}

§readonly firstName?: string
§readonly frequencyNumber?: number

Interval for the reminder

§readonly frequencyType?: "week" | "month" | "year" | "one_time"

Type of frequency of the reminder Default: "one_time"

§readonly genderId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getGenders"}

§readonly happenedAt?: string

Date when the activity happened

§readonly initialDate?: string

Date of the reminder

§readonly journalId?: string

ID of the journal entry to delete

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly messageId?: string

ID of the message to update

§readonly name?: string

Name of the tag - max 250 characters

§readonly noteId?: string

ID of the note to delete

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"

Default: "create"

§readonly post?: string

Content of the journal entry - max 100,000 characters

§readonly reminderId?: string

ID of the reminder to delete

§readonly resource?:
    | "tag"
    | "contact"
    | "contactTag"
    | "task"
    | "note"
    | "call"
    | "conversation"
    | "activity"
    | "contactField"
    | "conversationMessage"
    | "journalEntry"
    | "reminder"

Default: "contact"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly summary?: string

Brief description of the activity - max 255 characters

§readonly tagId?: string

ID of the tag to delete

§readonly tagsToAdd?: unknown[]

Tags to add to the contact. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getTagsToAdd"}

§readonly tagsToRemove?: unknown[]

Tags to remove from the contact. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getTagsToRemove"}

§readonly taskId?: string

ID of the task to delete

§readonly title?: string

Title of the journal entry - max 250 characters

§readonly updateFields?:
    | {
        activity_type_id?: string;
        contacts?: string;
        description?: string;
        happened_at?: string;
        summary?: string;
    }
    | {
        calledAt?: string;
        contactId?: string;
        content?: string;
    }
    | {
        birthdate?: string;
        deceased_date?: string;
        first_name?: string;
        gender_id?: string;
        is_deceased?: boolean;
        is_partial?: boolean;
        last_name?: string;
        nickname?: string;
    }
    | {
        contact_id?: string;
        content?: string;
        written_at?: string;
        written_by_me?: boolean;
    }
    | { post?: string; title?: string }
    | {
        body?: string;
        contact_id?: string;
        is_favorited?: boolean;
    }
    | {
        contact_id?: string;
        description?: string;
        frequency_number?: number;
        frequency_type?: | "week"
        | "month"
        | "year"
        | "one_time";
        initial_data?: string;
        title?: string;
    }
    | {
        completed?: boolean;
        contactId?: string;
        description?: string;
        title?: string;
    }

Default: {}

§readonly writtenAt?: string

Date when the message was written

§readonly writtenByMe?: boolean

Author of the message Default: true