nodes/generated

Interface SendyNodeParameters

Source
interface SendyNodeParameters {
    additionalFields?:
        | {
            excludeListIds?: string;
            excludeSegmentIds?: string;
            listIds?: string;
            plainText?: string;
            queryString?: string;
            segmentIds?: string;
            trackClicks?: boolean;
            trackOpens?: boolean;
        }
        | {
            country?: string;
            gdpr?: boolean;
            hp?: boolean;
            ipaddress?: string;
            name?: string;
            referrer?: string;
            silent?: boolean;
        };
    brandId?: string;
    email?: string;
    fromEmail?: string;
    fromName?: string;
    htmlText?: string;
    listId?: string;
    operation?: | "create"
    | "add"
    | "remove"
    | "delete"
    | "status"
    | "count";
    replyTo?: string;
    resource?: "campaign"
    | "subscriber";
    sendCampaign?: boolean;
    subject?: string;
    title?: string;
}

Properties§

§readonly additionalFields?:
    | {
        excludeListIds?: string;
        excludeSegmentIds?: string;
        listIds?: string;
        plainText?: string;
        queryString?: string;
        segmentIds?: string;
        trackClicks?: boolean;
        trackOpens?: boolean;
    }
    | {
        country?: string;
        gdpr?: boolean;
        hp?: boolean;
        ipaddress?: string;
        name?: string;
        referrer?: string;
        silent?: boolean;
    }

Default: {}

§readonly brandId?: string
§readonly email?: string

Email address of the subscriber

§readonly fromEmail?: string

The 'From email' of your campaign

§readonly fromName?: string

The 'From name' of your campaign

§readonly htmlText?: string

The 'HTML version' of your campaign

§readonly listId?: string

The list ID you want to subscribe a user to. This encrypted & hashed ID can be found under View all lists section named ID.

§readonly operation?: "create" | "add" | "remove" | "delete" | "status" | "count"

Default: "create"

§readonly replyTo?: string

The 'Reply to' of your campaign

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

Default: "subscriber"

§readonly sendCampaign?: boolean

Whether to send the campaign as well and not just create a draft. Default is false.

§readonly subject?: string

The 'Subject' of your campaign

§readonly title?: string

The 'Title' of your campaign