nodes/generated

Interface KeapNodeParameters

Source
interface KeapNodeParameters {
    additionalFields?:
        | {
            emailAddress?: string;
            notes?: string;
            optInReason?: string;
            website?: string;
        }
        | {
            anniversary?: string;
            companyId?: number;
            contactType?: string;
            familyName?: string;
            givenName?: string;
            ipAddress?: string;
            jobTitle?: string;
            leadSourceId?: number;
            middleName?: string;
            optInReason?: string;
            ownerId?: string;
            preferredLocale?: string;
            preferredName?: string;
            sourceType?: | "MANUAL"
            | "OTHER"
            | "API"
            | "IMPORT"
            | "LANDINGPAGE"
            | "UNKNOWN";
            spouseName?: string;
            timezone?: string;
            website?: string;
        }
        | {
            body?: string;
            title?: string;
            type?: | "other"
            | "email"
            | "appointment"
            | "call"
            | "fax"
            | "letter";
        }
        | {
            body?: string;
            contactId?: number;
            title?: string;
            type?: | "other"
            | "email"
            | "appointment"
            | "call"
            | "fax"
            | "letter";
            userId?: string;
        }
        | {
            leadAffiliateId?: number;
            promoCodes?: string;
            salesAffiliateId?: number;
        }
        | {
            active?: boolean;
            productDesc?: string;
            productPrice?: number;
            productShortDesc?: string;
            sku?: string;
            subscriptionOnly?: boolean;
        }
        | {
            clickedDate?: string;
            contactId?: number;
            headers?: string;
            htmlContent?: string;
            openedDate?: string;
            originalProvider?: | "UNKNOWN"
            | "INFUSIONSOFT"
            | "MICROSOFT"
            | "GOOGLE";
            originalProviderId?: string;
            plainContent?: string;
            providerSourceId?: string;
            receivedDate?: string;
            sentDate?: string;
            sentFromReplyAddress?: string;
            sentToBccAddresses?: string;
            sentToCCAddresses?: string;
            subject?: string;
        }
        | {
            addressField?: string;
            htmlContent?: string;
            plainContent?: string;
        };
    addressesUi?: | {
        addressesValues: {
            countryCode?: string;
            line1?: string;
            line2?: string;
            locality?: string;
            postalCode?: string;
            region?: string;
            zipCode?: string;
            zipFour?: string;
        };
    }
    | {
        addressesValues: {
            countryCode?: string;
            field?: "OTHER"
            | "BILLING"
            | "SHIPPING";
            line1?: string;
            line2?: string;
            locality?: string;
            postalCode?: string;
            region?: string;
            zipCode?: string;
            zipFour?: string;
        }[];
    };
    addressUi?: {
        addressValues: {
            company?: string;
            countryCode?: string;
            firstName?: string;
            lastName?: string;
            line1?: string;
            line2?: string;
            locality?: string;
            middleName?: string;
            phone?: string;
            region?: string;
            zipCode?: string;
            zipFour?: string;
        };
    };
    attachmentsUi?: {
        attachmentsBinary: { property?: string }[];
        attachmentsValues: {
            fileData?: string;
            fileName?: string;
        }[];
    };
    binaryData?: boolean;
    binaryPropertyName?: string;
    companyName?: string;
    contactId?: string;
    contactIds?: string;
    duplicateOption?: "email"
    | "emailAndName";
    emailsUi?: {
        emailsValues: {
            email?: string;
            field?: "EMAIL1" | "EMAIL2" | "EMAIL3";
        }[];
    };
    faxesUi?: | {
        faxesValues: { number?: string; type?: string };
    }
    | {
        faxesValues: {
            field?: "FAX1"
            | "FAX2";
            number?: string;
        }[];
    };
    fileAssociation?: "contact"
    | "company"
    | "user";
    fileData?: string;
    fileId?: string;
    fileName?: string;
    filters?:
        | { contactId?: number; userId?: string }
        | { active?: boolean }
        | {
            contactId?: number;
            email?: string;
            sinceSentDate?: string;
            untilSentDate?: string;
        }
        | {
            contactId?: number;
            name?: string;
            permission?: "company"
            | "user"
            | "both";
            type?:
                | "contact"
                | "image"
                | "application"
                | "hidden"
                | "ticket"
                | "import"
                | "fax"
                | "attachment"
                | "digitalProduct"
                | "funnel"
                | "logoThumnail"
                | "reSampledImage"
                | "styleCart"
                | "templateThumnail"
                | "webform";
            viewable?: "public"
            | "private"
            | "both";
        };
    isPublic?: boolean;
    limit?: number;
    noteId?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "upload"
    | "send"
    | "createRecord";
    options?: | {
        companyName?: string;
        fields?: string;
        order?: "id"
        | "name"
        | "datecreated";
        orderDirection?: "ascending" | "descending";
    }
    | { fields?: string }
    | {
        email?: string;
        familyName?: string;
        givenName?: string;
        order?: "id" | "email" | "name" | "date";
        orderDirection?: "ascending" | "descending";
        since?: string;
        until?: string;
    }
    | {
        contactId?: number;
        order?: string;
        paid?: boolean;
        productId?: number;
        since?: string;
        until?: string;
    };
    orderDate?: string;
    orderId?: string;
    orderItemsUi?: {
        orderItemsValues: {
            description?: string;
            price?: number;
            "product ID"?: number;
            quantity?: number;
        }[];
    };
    orderTitle?: string;
    orderType?: "offline"
    | "online";
    phonesUi?:
        | {
            phonesValues: { number?: string; type?: string }[];
        }
        | {
            phonesValues: {
                field?: | "PHONE1"
                | "PHONE2"
                | "PHONE3"
                | "PHONE4"
                | "PHONE5";
                number?: string;
            }[];
        };
    productId?: string;
    productName?: string;
    resource?: | "contact"
    | "contactTag"
    | "ecommerceOrder"
    | "company"
    | "file"
    | "email"
    | "contactNote"
    | "ecommerceProduct";
    returnAll?: boolean;
    sentFromAddress?: string;
    sentToAddress?: string;
    socialAccountsUi?: {
        socialAccountsValues: {
            name?: string;
            type?: "Facebook"
            | "Twitter"
            | "LinkedIn";
        }[];
    };
    subject?: string;
    tagIds?: string
    | unknown[];
    userId?: string;
}

Properties§

§readonly additionalFields?:
    | {
        emailAddress?: string;
        notes?: string;
        optInReason?: string;
        website?: string;
    }
    | {
        anniversary?: string;
        companyId?: number;
        contactType?: string;
        familyName?: string;
        givenName?: string;
        ipAddress?: string;
        jobTitle?: string;
        leadSourceId?: number;
        middleName?: string;
        optInReason?: string;
        ownerId?: string;
        preferredLocale?: string;
        preferredName?: string;
        sourceType?: | "MANUAL"
        | "OTHER"
        | "API"
        | "IMPORT"
        | "LANDINGPAGE"
        | "UNKNOWN";
        spouseName?: string;
        timezone?: string;
        website?: string;
    }
    | {
        body?: string;
        title?: string;
        type?: | "other"
        | "email"
        | "appointment"
        | "call"
        | "fax"
        | "letter";
    }
    | {
        body?: string;
        contactId?: number;
        title?: string;
        type?: | "other"
        | "email"
        | "appointment"
        | "call"
        | "fax"
        | "letter";
        userId?: string;
    }
    | {
        leadAffiliateId?: number;
        promoCodes?: string;
        salesAffiliateId?: number;
    }
    | {
        active?: boolean;
        productDesc?: string;
        productPrice?: number;
        productShortDesc?: string;
        sku?: string;
        subscriptionOnly?: boolean;
    }
    | {
        clickedDate?: string;
        contactId?: number;
        headers?: string;
        htmlContent?: string;
        openedDate?: string;
        originalProvider?: | "UNKNOWN"
        | "INFUSIONSOFT"
        | "MICROSOFT"
        | "GOOGLE";
        originalProviderId?: string;
        plainContent?: string;
        providerSourceId?: string;
        receivedDate?: string;
        sentDate?: string;
        sentFromReplyAddress?: string;
        sentToBccAddresses?: string;
        sentToCCAddresses?: string;
        subject?: string;
    }
    | {
        addressField?: string;
        htmlContent?: string;
        plainContent?: string;
    }

Default: {}

§readonly addressesUi?:
    | {
        addressesValues: {
            countryCode?: string;
            line1?: string;
            line2?: string;
            locality?: string;
            postalCode?: string;
            region?: string;
            zipCode?: string;
            zipFour?: string;
        };
    }
    | {
        addressesValues: {
            countryCode?: string;
            field?: "OTHER"
            | "BILLING"
            | "SHIPPING";
            line1?: string;
            line2?: string;
            locality?: string;
            postalCode?: string;
            region?: string;
            zipCode?: string;
            zipFour?: string;
        }[];
    }

Default: {} Type options: {"multipleValues":false}

§readonly addressUi?: { ... }

Default: {} Type options: {"multipleValues":false}

§readonly attachmentsUi?: { ... }

Attachments to be sent with each copy of the email, maximum of 10 with size of 1MB each Default: {} Type options: {"multipleValues":true}

§readonly binaryData?: boolean

Whether the data to upload should be taken from binary field

§readonly binaryPropertyName?: string

Default: "data"

§readonly companyName?: string
§readonly contactId?: string
§readonly contactIds?: string

Contact IDs to receive the email. Multiple can be added seperated by comma.

§readonly duplicateOption?: "email" | "emailAndName"

Performs duplicate checking by one of the following options: Email, EmailAndName. If a match is found using the option provided, the existing contact will be updated. Default: "email"

§readonly emailsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly faxesUi?:
    | {
        faxesValues: { number?: string; type?: string };
    }
    | {
        faxesValues: {
            field?: "FAX1"
            | "FAX2";
            number?: string;
        }[];
    }

Default: {} Type options: {"multipleValues":false}

§readonly fileAssociation?: "contact" | "company" | "user"
§readonly fileData?: string

The content of the attachment, encoded in Base64

§readonly fileId?: string
§readonly fileName?: string

The filename of the attached file, including extension

§readonly filters?:
    | { contactId?: number; userId?: string }
    | { active?: boolean }
    | {
        contactId?: number;
        email?: string;
        sinceSentDate?: string;
        untilSentDate?: string;
    }
    | {
        contactId?: number;
        name?: string;
        permission?: "company"
        | "user"
        | "both";
        type?:
            | "contact"
            | "image"
            | "application"
            | "hidden"
            | "ticket"
            | "import"
            | "fax"
            | "attachment"
            | "digitalProduct"
            | "funnel"
            | "logoThumnail"
            | "reSampledImage"
            | "styleCart"
            | "templateThumnail"
            | "webform";
        viewable?: "public"
        | "private"
        | "both";
    }

Default: {}

§readonly isPublic?: boolean
§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":200}

§readonly noteId?: string
§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "upload"
    | "send"
    | "createRecord"

Default: "create"

§readonly options?:
    | {
        companyName?: string;
        fields?: string;
        order?: "id"
        | "name"
        | "datecreated";
        orderDirection?: "ascending" | "descending";
    }
    | { fields?: string }
    | {
        email?: string;
        familyName?: string;
        givenName?: string;
        order?: "id" | "email" | "name" | "date";
        orderDirection?: "ascending" | "descending";
        since?: string;
        until?: string;
    }
    | {
        contactId?: number;
        order?: string;
        paid?: boolean;
        productId?: number;
        since?: string;
        until?: string;
    }

Default: {}

§readonly orderDate?: string
§readonly orderId?: string
§readonly orderItemsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly orderTitle?: string
§readonly orderType?: "offline" | "online"
§readonly phonesUi?:
    | {
        phonesValues: { number?: string; type?: string }[];
    }
    | {
        phonesValues: {
            field?: | "PHONE1"
            | "PHONE2"
            | "PHONE3"
            | "PHONE4"
            | "PHONE5";
            number?: string;
        }[];
    }

Default: {} Type options: {"multipleValues":true}

§readonly productId?: string
§readonly productName?: string
§readonly resource?:
    | "contact"
    | "contactTag"
    | "ecommerceOrder"
    | "company"
    | "file"
    | "email"
    | "contactNote"
    | "ecommerceProduct"

Default: "company"

§readonly returnAll?: boolean

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

§readonly sentFromAddress?: string
§readonly sentToAddress?: string
§readonly socialAccountsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly subject?: string

The subject line of the email

§readonly tagIds?: string | unknown[]

Choose from the list, or specify IDs using an expression Default: [] Type options: {"loadOptionsMethod":"getTags"}

§readonly userId?: string

The infusionsoft user to create the note on behalf of. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getUsers"}