nodes/generated

Interface SendGridNodeParameters

Source
interface SendGridNodeParameters {
    additionalFields?:
        | {
            addressUi?: {
                addressValues: {
                    address1?: string;
                    address2?: string;
                };
            };
            alternateEmails?: string;
            city?: string;
            country?: string;
            customFieldsUi?: {
                customFieldValues: {
                    fieldId?: string;
                    fieldValue?: string;
                }[];
            };
            firstName?: string;
            lastName?: string;
            listIdsUi?: { listIdValues: { listIds?: unknown[] } };
            postalCode?: string;
            stateProvinceRegion?: string;
        }
        | {
            attachments?: string;
            bccEmail?: string;
            categories?: string;
            ccEmail?: string;
            enableSandbox?: boolean;
            headers?: {
                details: { key?: string; value?: string }[];
            };
            ipPoolName?: string;
            replyToEmail?: string;
            sendAt?: string;
        };
    by?: "id"
    | "email";
    contactId?: string;
    contactSample?: boolean;
    contentType?: "text/plain" | "text/html";
    contentValue?: string;
    deleteAll?: boolean;
    deleteContacts?: boolean;
    dynamicTemplate?: boolean;
    dynamicTemplateFields?: {
        fields: { key?: string; value?: string }[];
    };
    email?: string;
    filters?: { query?: string };
    fromEmail?: string;
    fromName?: string;
    ids?: string;
    limit?: number;
    listId?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "upsert"
        | "send";
    resource?: "contact"
    | "list"
    | "mail";
    returnAll?: boolean;
    subject?: string;
    templateId?: string;
    toEmail?: string;
}

Properties§

§readonly additionalFields?:
    | {
        addressUi?: {
            addressValues: {
                address1?: string;
                address2?: string;
            };
        };
        alternateEmails?: string;
        city?: string;
        country?: string;
        customFieldsUi?: {
            customFieldValues: {
                fieldId?: string;
                fieldValue?: string;
            }[];
        };
        firstName?: string;
        lastName?: string;
        listIdsUi?: { listIdValues: { listIds?: unknown[] } };
        postalCode?: string;
        stateProvinceRegion?: string;
    }
    | {
        attachments?: string;
        bccEmail?: string;
        categories?: string;
        ccEmail?: string;
        enableSandbox?: boolean;
        headers?: {
            details: { key?: string; value?: string }[];
        };
        ipPoolName?: string;
        replyToEmail?: string;
        sendAt?: string;
    }

Default: {}

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

Search the user by ID or email Default: "id"

§readonly contactId?: string

ID of the contact

§readonly contactSample?: boolean

Whether to return the contact sample

§readonly contentType?: "text/plain" | "text/html"

MIME type of the email to send Default: "text/plain"

§readonly contentValue?: string

Message body of the email to send

§readonly deleteAll?: boolean

Whether all contacts will be deleted

§readonly deleteContacts?: boolean

Whether to delete all contacts on the list

§readonly dynamicTemplate?: boolean

Whether this email will contain a dynamic template

§readonly dynamicTemplateFields?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly email?: string

Primary email for the contact

§readonly filters?: { ... }

Default: {}

§readonly fromEmail?: string

Email address of the sender of the email

§readonly fromName?: string

Name of the sender of the email

§readonly ids?: string

ID of the contact. Multiple can be added separated by comma.

§readonly limit?: number

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

§readonly listId?: string

ID of the list

§readonly name?: string

Name of the list

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "upsert"
    | "send"

Default: "create"

§readonly resource?: "contact" | "list" | "mail"

Default: "list"

§readonly returnAll?: boolean

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

§readonly subject?: string

Subject of the email to send

§readonly templateId?: string

Choose from the list, or specify an ID using an expression Default: [] Type options: {"loadOptionsMethod":"getTemplateIds"}

§readonly toEmail?: string

Comma-separated list of recipient email addresses