nodes/generated

Interface GetResponseNodeParameters

Source
interface GetResponseNodeParameters {
    additionalFields?: {
        customFieldsUi?: {
            customFieldValues: {
                customFieldId?: string;
                value?: string;
            }[];
        };
        dayOfCycle?: string;
        ipAddress?: string;
        name?: string;
        note?: string;
        scoring?: number;
        tags?: unknown[];
    };
    authentication?: "apiKey"
    | "oAuth2";
    campaignId?: string;
    contactId?: string;
    email?: string;
    limit?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete";
    options?: | { ipAddress?: string; messageId?: string }
    | { fields?: string }
    | {
        campaignId?: string;
        changeOnFrom?: string;
        changeOnTo?: string;
        createdOnFrom?: string;
        createdOnTo?: string;
        exactMatch?: boolean;
        fields?: string;
        name?: string;
        origin?:
            | "api"
            | "email"
            | "copy"
            | "forward"
            | "import"
            | "iphone"
            | "landing_page"
            | "leads"
            | "panel"
            | "sale"
            | "survey"
            | "webinar"
            | "www";
        sortBy?: | "email"
        | "campaignId"
        | "changedOn"
        | "createdOn";
        sortOrder?: "ASC"
        | "DESC";
    };
    resource?: "contact";
    returnAll?: boolean;
    updateFields?: {
        campaignId?: string;
        customFieldsUi?: {
            customFieldValues: {
                customFieldId?: string;
                value?: string;
            }[];
        };
        dayOfCycle?: string;
        email?: string;
        ipAddress?: string;
        name?: string;
        note?: string;
        scoring?: number;
        tags?: unknown[];
    };
}

Properties§

Source§

readonly additionalFields?: {
    customFieldsUi?: {
        customFieldValues: {
            customFieldId?: string;
            value?: string;
        }[];
    };
    dayOfCycle?: string;
    ipAddress?: string;
    name?: string;
    note?: string;
    scoring?: number;
    tags?: unknown[];
}

Default: {}

Source§

readonly authentication?: "apiKey" | "oAuth2"

Default: "apiKey"

Source§

readonly campaignId?: string

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

Source§

readonly contactId?: string

ID of contact to delete

Source§

readonly email?: string

Source§

readonly limit?: number

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

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "get"

Source§

readonly options?:
    | { ipAddress?: string; messageId?: string }
    | { fields?: string }
    | {
        campaignId?: string;
        changeOnFrom?: string;
        changeOnTo?: string;
        createdOnFrom?: string;
        createdOnTo?: string;
        exactMatch?: boolean;
        fields?: string;
        name?: string;
        origin?:
            | "api"
            | "email"
            | "copy"
            | "forward"
            | "import"
            | "iphone"
            | "landing_page"
            | "leads"
            | "panel"
            | "sale"
            | "survey"
            | "webinar"
            | "www";
        sortBy?: | "email"
        | "campaignId"
        | "changedOn"
        | "createdOn";
        sortOrder?: "ASC"
        | "DESC";
    }

Default: {}

Source§

readonly resource?: "contact"

Default: "contact"

Source§

readonly returnAll?: boolean

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

Source§

readonly updateFields?: {
    campaignId?: string;
    customFieldsUi?: {
        customFieldValues: {
            customFieldId?: string;
            value?: string;
        }[];
    };
    dayOfCycle?: string;
    email?: string;
    ipAddress?: string;
    name?: string;
    note?: string;
    scoring?: number;
    tags?: unknown[];
}

Default: {}