nodes/generated

Interface ConvertKitNodeParameters

Source
interface ConvertKitNodeParameters {
    additionalFields?:
        | {
            fieldsUi?: {
                fieldsValues: { key?: string; value?: string }[];
            };
            firstName?: string;
        }
        | { subscriberState?: "active"
        | "cancelled" }
        | {
            fieldsUi?: {
                fieldsValues: { key?: string; value?: string }[];
            };
            firstName?: string;
            tags?: unknown[];
        }
        | {
            fields?: {
                field: { key?: string; value?: string }[];
            };
            firstName?: string;
        };
    email?: string;
    id?: string;
    label?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "getAll"
    | "update"
    | "add"
    | "delete"
    | "addSubscriber"
    | "getSubscriptions";
    resource?: | "tag"
    | "form"
    | "customField"
    | "sequence"
    | "tagSubscriber";
    returnAll?: boolean;
    tagId?: string;
}

Properties§

§readonly additionalFields?:
    | {
        fieldsUi?: {
            fieldsValues: { key?: string; value?: string }[];
        };
        firstName?: string;
    }
    | { subscriberState?: "active"
    | "cancelled" }
    | {
        fieldsUi?: {
            fieldsValues: { key?: string; value?: string }[];
        };
        firstName?: string;
        tags?: unknown[];
    }
    | {
        fields?: {
            field: { key?: string; value?: string }[];
        };
        firstName?: string;
    }

Default: {}

§readonly email?: string

The subscriber's email address

§readonly id?: string

The ID of your custom field

§readonly label?: string

The label of the custom field

§readonly limit?: number

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

§readonly name?: string

Tag name, multiple can be added separated by comma

§readonly operation?:
    | "create"
    | "getAll"
    | "update"
    | "add"
    | "delete"
    | "addSubscriber"
    | "getSubscriptions"

Default: "update"

§readonly resource?:
    | "tag"
    | "form"
    | "customField"
    | "sequence"
    | "tagSubscriber"

Default: "form"

§readonly returnAll?: boolean

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

§readonly tagId?: string

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