nodes/generated

Interface IterableNodeParameters

Source


interface IterableNodeParameters {
    additionalFields?:
        | {
            campaignId?: string;
            createdAt?: string;
            dataFieldsUi?: {
                dataFieldValues: { key?: string; value?: string }[];
            };
            email?: string;
            id?: string;
            templateId?: string;
            userId?: string;
        }
        | {
            dataFieldsUi?: {
                dataFieldValues: { key?: string; value?: string }[];
            };
            mergeNestedObjects?: boolean;
        }
        | {
            campaignId?: number;
            channelUnsubscribe?: boolean;
        };
    by?: "email"
    | "userId";
    email?: string;
    identifier?: "email" | "userId";
    listId?: string;
    name?: string;
    operation?:
        | "get"
        | "add"
        | "remove"
        | "delete"
        | "upsert"
        | "track";
    preferUserId?: boolean;
    resource?: "event"
    | "user"
    | "userList";
    userId?: string;
    value?: string;
}

Properties§

§readonly additionalFields?:
    | {
        campaignId?: string;
        createdAt?: string;
        dataFieldsUi?: {
            dataFieldValues: { key?: string; value?: string }[];
        };
        email?: string;
        id?: string;
        templateId?: string;
        userId?: string;
    }
    | {
        dataFieldsUi?: {
            dataFieldValues: { key?: string; value?: string }[];
        };
        mergeNestedObjects?: boolean;
    }
    | { campaignId?: number; channelUnsubscribe?: boolean }

Default: {}

§readonly by?: "email" | "userId"

Identifier to be used Default: "email"

§readonly email?: string

Email for a particular user

§readonly identifier?: "email" | "userId"

Identifier to be used

§readonly listId?: string

Identifier to be used. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getLists"}

§readonly name?: string

The name of the event to track

§readonly operation?: "get" | "add" | "remove" | "delete" | "upsert" | "track"

Default: "track"

§readonly preferUserId?: boolean

Whether to create a new user if the idetifier does not exist Default: true

§readonly resource?: "event" | "user" | "userList"

Default: "user"

§readonly userId?: string

Unique identifier for a particular user

§readonly value?: string