nodes/generated

Interface EmeliaNodeParameters

Source


interface EmeliaNodeParameters {
    additionalFields?: {
        customFieldsUi?: {
            customFieldsValues: {
                fieldName?: string;
                value?: string;
            }[];
        };
        firstName?: string;
        lastContacted?: string;
        lastName?: string;
        lastOpen?: string;
        lastReplied?: string;
        mailsSent?: number;
        phoneNumber?: string;
    };
    campaignId?: string;
    campaignName?: string;
    contactEmail?: string;
    contactListId?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "add"
    | "start"
    | "addContact"
    | "duplicate"
    | "pause";
    options?: {
        copyContacts?: boolean;
        copyMails?: boolean;
        copyProvider?: boolean;
        copySettings?: boolean;
    };
    resource?: "contactList"
    | "campaign";
    returnAll?: boolean;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly campaignId?: string

The ID of the campaign to add the contact to. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getCampaigns"}

§readonly campaignName?: string

The name of the campaign to create

§readonly contactEmail?: string

The email of the contact to add to the campaign

§readonly contactListId?: string

The ID of the contact list to add the contact to. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsMethod":"getContactLists"}

§readonly limit?: number

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

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "add"
    | "start"
    | "addContact"
    | "duplicate"
    | "pause"

Default: "get"

§readonly options?: { ... }

Default: {}

§readonly resource?: "contactList" | "campaign"

Default: "campaign"

§readonly returnAll?: boolean

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