nodes/generated

Interface EgoiNodeParameters

Source


interface EgoiNodeParameters {
    additionalFields?: {
        birth_date?: string;
        cellphone?: string;
        extraFieldsUi?: {
            extraFieldValues: {
                field_id?: string;
                value?: string;
            }[];
        };
        first_name?: string;
        last_name?: string;
        status?: | "active"
        | "unconfirmed"
        | "inactive"
        | "removed";
        tagIds?: unknown[];
    };
    by?: "id"
    | "email";
    contactId?: string;
    email?: string;
    limit?: number;
    list?: string;
    operation?: "create" | "get" | "getAll" | "update";
    resolveData?: boolean;
    resource?: "contact";
    returnAll?: boolean;
    simple?: boolean;
    updateFields?: {
        birth_date?: string;
        cellphone?: string;
        email?: string;
        extraFieldsUi?: {
            extraFieldValues: {
                field_id?: string;
                value?: string;
            }[];
        };
        first_name?: string;
        last_name?: string;
        status?: | "active"
        | "unconfirmed"
        | "inactive"
        | "removed";
        tagIds?: unknown[];
    };
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

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

Search by Default: "id"

§readonly contactId?: string

Contact ID of the subscriber

§readonly email?: string

Email address for a subscriber

§readonly limit?: number

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

§readonly list?: string

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

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

Default: "create"

§readonly resolveData?: boolean

By default the response just includes the contact ID. If this option gets activated, it will resolve the data automatically. Default: true

§readonly resource?: "contact"

Default: "contact"

§readonly returnAll?: boolean

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

§readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

§readonly updateFields?: { ... }

Default: {}