nodes/generated

Interface MailchimpNodeParameters

Source
interface MailchimpNodeParameters {
    authentication?: "apiKey" | "oAuth2";
    campaignId?: string;
    email?: string;
    groupCategory?: string;
    groupJson?: string;
    groupsUi?: {
        groupsValues: {
            categoryFieldId?: string;
            categoryId?: string;
            value?: boolean;
        }[];
    };
    jsonParameters?: boolean;
    limit?: number;
    list?: string;
    locationFieldsUi?: {
        locationFieldsValues: {
            latitude: string;
            longitude: string;
        };
    };
    locationJson?: string;
    mergeFieldsJson?: string;
    mergeFieldsUi?: {
        mergeFieldsValues: { name: string; value: string }[];
    };
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "send"
    | "replicate"
    | "resend";
    options?: | {
        emailType?: "text"
        | "html";
        ipOptIn?: string;
        ipSignup?: string;
        language?: string;
        tags?: string;
        timestampOpt?: string;
        timestampSignup?: string;
        vip?: boolean;
    }
    | { excludeFields?: string; fields?: string }
    | {
        beforeLastChanged?: string;
        beforeTimestampOpt?: string;
        emailType?: "text" | "html";
        sinceLastChanged?: string;
        status?:
            | "subscribed"
            | "unsubscribed"
            | "transactional"
            | "pending"
            | "cleaned";
    }
    | { isSyncing?: boolean }
    | {
        beforeCreateTime?: string;
        beforeSendTime?: string;
        excludeFields?: unknown[];
        fields?: unknown[];
        listId?: string;
        sinceCreateTime?: string;
        sinceSendTime?: string;
        sortDirection?: "ASC" | "DESC";
        sortField?: "create_time" | "send_time";
        status?: "save" | "sent" | "schedule" | "sending";
    };
    resource?: | "member"
    | "campaign"
    | "listGroup"
    | "memberTag";
    returnAll?: boolean;
    status?: | "subscribed"
    | "unsubscribed"
    | "transactional"
    | "pending"
    | "cleaned";
    tags?: string;
    updateFields?: {
        emailType?: "text"
        | "html";
        groupsUi?: {
            groupsValues: {
                categoryFieldId?: string;
                categoryId?: string;
                value?: boolean;
            }[];
        };
        ipOptIn?: string;
        ipSignup?: string;
        language?: string;
        locationFieldsUi?: {
            locationFieldsValues: {
                latitude: string;
                longitude: string;
            };
        };
        mergeFieldsUi?: {
            mergeFieldsValues: { name: string; value: string }[];
        };
        skipMergeValidation?: boolean;
        status?: | "subscribed"
        | "unsubscribed"
        | "transactional"
        | "pending"
        | "cleaned";
        timestampOpt?: string;
        timestampSignup?: string;
        vip?: boolean;
    };
}

Properties§

Source§

readonly authentication?: "apiKey" | "oAuth2"

Default: "apiKey"

Source§

readonly campaignId?: string

List of Campaigns

Source§

readonly email?: string

Email address for a subscriber

Source§

readonly groupCategory?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getGroupCategories","loadOptionsDependsOn":["list"]}

Source§

readonly groupJson?: string

Type options: {"alwaysOpenEditWindow":true}

Source§

readonly groupsUi?: {
    groupsValues: {
        categoryFieldId?: string;
        categoryId?: string;
        value?: boolean;
    }[];
}

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

Source§

readonly jsonParameters?: boolean

Source§

readonly limit?: number

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

Source§

readonly list?: string

List of lists. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getLists"}

Source§

readonly locationFieldsUi?: {
    locationFieldsValues: {
        latitude: string;
        longitude: string;
    };
}

Subscriber location information.n Default: {}

Source§

readonly locationJson?: string

Type options: {"alwaysOpenEditWindow":true}

Source§

readonly mergeFieldsJson?: string

Type options: {"alwaysOpenEditWindow":true}

Source§

readonly mergeFieldsUi?: { mergeFieldsValues: { name: string; value: string }[] }

An individual merge var and value for a member Default: {} Type options: {"multipleValues":true}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "send"
    | "replicate"
    | "resend"

Default: "create"

Source§

readonly options?:
    | {
        emailType?: "text"
        | "html";
        ipOptIn?: string;
        ipSignup?: string;
        language?: string;
        tags?: string;
        timestampOpt?: string;
        timestampSignup?: string;
        vip?: boolean;
    }
    | { excludeFields?: string; fields?: string }
    | {
        beforeLastChanged?: string;
        beforeTimestampOpt?: string;
        emailType?: "text" | "html";
        sinceLastChanged?: string;
        status?:
            | "subscribed"
            | "unsubscribed"
            | "transactional"
            | "pending"
            | "cleaned";
    }
    | { isSyncing?: boolean }
    | {
        beforeCreateTime?: string;
        beforeSendTime?: string;
        excludeFields?: unknown[];
        fields?: unknown[];
        listId?: string;
        sinceCreateTime?: string;
        sinceSendTime?: string;
        sortDirection?: "ASC" | "DESC";
        sortField?: "create_time" | "send_time";
        status?: "save" | "sent" | "schedule" | "sending";
    }

Default: {}

Source§

readonly resource?: "member" | "campaign" | "listGroup" | "memberTag"

Default: "member"

Source§

readonly returnAll?: boolean

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

Source§

readonly status?:
    | "subscribed"
    | "unsubscribed"
    | "transactional"
    | "pending"
    | "cleaned"

Subscriber's current status

Source§

readonly tags?: string

Default: [] Type options: {"multipleValues":true,"multipleValueButtonText":"Add Tag"}

Source§

readonly updateFields?: {
    emailType?: "text" | "html";
    groupsUi?: {
        groupsValues: {
            categoryFieldId?: string;
            categoryId?: string;
            value?: boolean;
        }[];
    };
    ipOptIn?: string;
    ipSignup?: string;
    language?: string;
    locationFieldsUi?: {
        locationFieldsValues: {
            latitude: string;
            longitude: string;
        };
    };
    mergeFieldsUi?: {
        mergeFieldsValues: { name: string; value: string }[];
    };
    skipMergeValidation?: boolean;
    status?: | "subscribed"
    | "unsubscribed"
    | "transactional"
    | "pending"
    | "cleaned";
    timestampOpt?: string;
    timestampSignup?: string;
    vip?: boolean;
}

Default: {}