nodes/generated

Interface ActionNetworkNodeParameters

Source
interface ActionNetworkNodeParameters {
    additionalFields?:
        | {
            browser_url?: string;
            description?: string;
            end_date?: string;
            featured_image_url?: string;
            instructions?: string;
            location?: {
                postal_addresses_fields: {
                    address_lines?: string;
                    country?: string;
                    language?: string;
                    locality?: string;
                    location?: {
                        location_fields: {
                            latitude?: string;
                            longitude?: string;
                        };
                    };
                    postal_code?: string;
                    primary?: boolean;
                    region?: string;
                };
            };
            name?: string;
            start_date?: string;
        }
        | {
            family_name?: string;
            given_name?: string;
            languages_spoken?: | "da"
            | "nl"
            | "en"
            | "fi"
            | "fr"
            | "de"
            | "hu"
            | "id"
            | "ja"
            | "pt"
            | "br"
            | "ru"
            | "es"
            | "sv"
            | "tr"
            | "cy";
            phone_numbers?: {
                phone_numbers_fields: {
                    number?: string;
                    primary?: unknown;
                    status?: | "bouncing"
                    | "previous bounce"
                    | "subscribed"
                    | "unsubscribed";
                };
            };
            postal_addresses?: {
                postal_addresses_fields: {
                    address_lines?: string;
                    country?: string;
                    language?: string;
                    locality?: string;
                    location?: {
                        location_fields: {
                            latitude?: string;
                            longitude?: string;
                        };
                    };
                    postal_code?: string;
                    primary?: boolean;
                    region?: string;
                }[];
            };
        }
        | {
            browser_url?: string;
            featured_image_url?: string;
            name?: string;
            petition_text?: string;
            target?: string;
        }
        | { comments?: string };
    attendanceId?: string;
    email_addresses?: {
        email_addresses_fields: {
            address?: string;
            primary?: unknown;
            status?:
                | "bouncing"
                | "previous bounce"
                | "subscribed"
                | "unsubscribed"
                | "previous spam complaint"
                | "spam complaint";
        };
    };
    eventId?: string;
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove";
    originSystem?: string;
    personId?: string;
    petitionId?: string;
    resource?: | "attendance"
    | "event"
    | "person"
    | "personTag"
    | "petition"
    | "signature"
    | "tag";
    returnAll?: boolean;
    signatureId?: string;
    simple?: boolean;
    taggingId?: string;
    tagId?: string;
    title?: string;
    updateFields?: | {
        family_name?: string;
        given_name?: string;
        languages_spoken?: | "da"
        | "nl"
        | "en"
        | "fi"
        | "fr"
        | "de"
        | "hu"
        | "id"
        | "ja"
        | "pt"
        | "br"
        | "ru"
        | "es"
        | "sv"
        | "tr"
        | "cy";
        phone_numbers?: {
            phone_numbers_fields: {
                number?: string;
                primary?: unknown;
                status?: | "bouncing"
                | "previous bounce"
                | "subscribed"
                | "unsubscribed";
            };
        };
        postal_addresses?: {
            postal_addresses_fields: {
                address_lines?: string;
                country?: string;
                language?: string;
                locality?: string;
                location?: {
                    location_fields: {
                        latitude?: string;
                        longitude?: string;
                    };
                };
                postal_code?: string;
                primary?: boolean;
                region?: string;
            }[];
        };
    }
    | {
        browser_url?: string;
        featured_image_url?: string;
        name?: string;
        petition_text?: string;
        target?: string;
    }
    | { comments?: string };
}

Properties§

§readonly additionalFields?:
    | {
        browser_url?: string;
        description?: string;
        end_date?: string;
        featured_image_url?: string;
        instructions?: string;
        location?: {
            postal_addresses_fields: {
                address_lines?: string;
                country?: string;
                language?: string;
                locality?: string;
                location?: {
                    location_fields: {
                        latitude?: string;
                        longitude?: string;
                    };
                };
                postal_code?: string;
                primary?: boolean;
                region?: string;
            };
        };
        name?: string;
        start_date?: string;
    }
    | {
        family_name?: string;
        given_name?: string;
        languages_spoken?: | "da"
        | "nl"
        | "en"
        | "fi"
        | "fr"
        | "de"
        | "hu"
        | "id"
        | "ja"
        | "pt"
        | "br"
        | "ru"
        | "es"
        | "sv"
        | "tr"
        | "cy";
        phone_numbers?: {
            phone_numbers_fields: {
                number?: string;
                primary?: unknown;
                status?: | "bouncing"
                | "previous bounce"
                | "subscribed"
                | "unsubscribed";
            };
        };
        postal_addresses?: {
            postal_addresses_fields: {
                address_lines?: string;
                country?: string;
                language?: string;
                locality?: string;
                location?: {
                    location_fields: {
                        latitude?: string;
                        longitude?: string;
                    };
                };
                postal_code?: string;
                primary?: boolean;
                region?: string;
            }[];
        };
    }
    | {
        browser_url?: string;
        featured_image_url?: string;
        name?: string;
        petition_text?: string;
        target?: string;
    }
    | { comments?: string }

Default: {}

§readonly attendanceId?: string

ID of the attendance to retrieve

§readonly email_addresses?: { ... }

Person’s email addresses Default: {}

§readonly eventId?: string

ID of the event to create an attendance for

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly name?: string

Name of the tag to create

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

Default: "create"

§readonly originSystem?: string

Source where the event originated

§readonly personId?: string

ID of the person to create an attendance for

§readonly petitionId?: string

ID of the petition to retrieve

§readonly resource?:
    | "attendance"
    | "event"
    | "person"
    | "personTag"
    | "petition"
    | "signature"
    | "tag"

Default: "attendance"

§readonly returnAll?: boolean

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

§readonly signatureId?: string

ID of the signature to retrieve

§readonly simple?: boolean

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

§readonly taggingId?: string

ID of the tagging to remove. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"loadOptionsDependsOn":["tagId"],"loadOptionsMethod":"getTaggings"}

§readonly tagId?: string

ID of the tag to retrieve

§readonly title?: string

Title of the event to create

§readonly updateFields?:
    | {
        family_name?: string;
        given_name?: string;
        languages_spoken?: | "da"
        | "nl"
        | "en"
        | "fi"
        | "fr"
        | "de"
        | "hu"
        | "id"
        | "ja"
        | "pt"
        | "br"
        | "ru"
        | "es"
        | "sv"
        | "tr"
        | "cy";
        phone_numbers?: {
            phone_numbers_fields: {
                number?: string;
                primary?: unknown;
                status?: | "bouncing"
                | "previous bounce"
                | "subscribed"
                | "unsubscribed";
            };
        };
        postal_addresses?: {
            postal_addresses_fields: {
                address_lines?: string;
                country?: string;
                language?: string;
                locality?: string;
                location?: {
                    location_fields: {
                        latitude?: string;
                        longitude?: string;
                    };
                };
                postal_code?: string;
                primary?: boolean;
                region?: string;
            }[];
        };
    }
    | {
        browser_url?: string;
        featured_image_url?: string;
        name?: string;
        petition_text?: string;
        target?: string;
    }
    | { comments?: string }

Default: {}