nodes/generated

Interface AutomizyNodeParameters

Source
interface AutomizyNodeParameters {
    additionalFields?:
        | {
            customFieldsUi?: {
                customFieldsValues: {
                    key?: string;
                    value?: string;
                }[];
            };
            status?: | "ACTIVE"
            | "BANNED"
            | "BOUNCED"
            | "INACTIVE"
            | "UNSUBSCRIBED";
            tags?: unknown[];
        }
        | {
            direction?: "asc"
            | "desc";
            fields?: string;
            sortBy?: string;
        };
    contactId?: string;
    email?: string;
    limit?: number;
    listId?: string;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    resource?: "contact"
    | "list";
    returnAll?: boolean;
    updateFields?: {
        addTags?: unknown[];
        customFieldsUi?: {
            customFieldsValues: {
                key?: string;
                value?: string;
            }[];
        };
        removeTags?: unknown[];
        status?: | "ACTIVE"
        | "BANNED"
        | "BOUNCED"
        | "INACTIVE"
        | "UNSUBSCRIBED";
        tags?: unknown[];
    };
}

Properties§

Source§

readonly additionalFields?:
    | {
        customFieldsUi?: {
            customFieldsValues: {
                key?: string;
                value?: string;
            }[];
        };
        status?: | "ACTIVE"
        | "BANNED"
        | "BOUNCED"
        | "INACTIVE"
        | "UNSUBSCRIBED";
        tags?: unknown[];
    }
    | {
        direction?: "asc"
        | "desc";
        fields?: string;
        sortBy?: string;
    }

Default: {}

Source§

readonly contactId?: string

Can be ID or email

Source§

readonly email?: string

The email address of the contact

Source§

readonly limit?: number

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

Source§

readonly listId?: string

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

Source§

readonly name?: string

Source§

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

Default: "create"

Source§

readonly resource?: "contact" | "list"

Default: "contact"

Source§

readonly returnAll?: boolean

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

Source§

readonly updateFields?: {
    addTags?: unknown[];
    customFieldsUi?: {
        customFieldsValues: {
            key?: string;
            value?: string;
        }[];
    };
    removeTags?: unknown[];
    status?: | "ACTIVE"
    | "BANNED"
    | "BOUNCED"
    | "INACTIVE"
    | "UNSUBSCRIBED";
    tags?: unknown[];
}

Default: {}