nodes/generated

Interface BrevoNodeParameters

Source
interface BrevoNodeParameters {
    additionalFields?:
        | {
            emailAttachments?: {
                attachment: { binaryPropertyName?: string };
            };
            emailTags?: { tags: { tag?: string } };
            receipientsBCC?: { receipientBcc: { bcc?: string } };
            receipientsCC?: { receipientCc: { cc?: string } };
        }
        | {
            emailAttachments?: {
                attachment: { binaryPropertyName?: string };
            };
            emailTags?: { tags: { tag?: string } };
            templateParameters?: {
                parameterValues: { parameters?: string };
            };
        };
    attributeCategory?: | "calculated"
    | "category"
    | "global"
    | "normal"
    | "transactional";
    attributeCategoryList?: {
        categoryEnumeration?: {
            attributesValues: {
                attributeCategoryLabel?: string;
                attributeCategoryValue?: number;
            }[];
        };
    };
    attributeName?: string;
    attributeType?: "boolean"
    | "text"
    | "date"
    | "float";
    attributeValue?: string;
    createContactAttributes?: {
        attributesValues: {
            fieldName?: string;
            fieldValue?: string;
        }[];
    };
    deleteAttributeCategory?: | "calculated"
    | "category"
    | "global"
    | "normal"
    | "transactional";
    deleteAttributeName?: string;
    email?: string;
    filters?: { modifiedSince?: string };
    htmlContent?: string;
    id?: string;
    identifier?: string;
    limit?: number;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "upsert"
        | "send"
        | "sendTemplate";
    options?: { sort?: "asc"
    | "desc" };
    receipients?: string;
    resource?: "contact" | "email" | "attribute" | "sender";
    returnAll?: boolean;
    sender?: string;
    sendHTML?: boolean;
    subject?: string;
    templateId?: string;
    textContent?: string;
    updateAttributeCategory?:
        | "calculated"
        | "category"
        | "global";
    updateAttributeCategoryList?: {
        updateCategoryEnumeration?: {
            updateAttributesValues: {
                attributeCategoryLabel?: string;
                attributeCategoryValue?: number;
            }[];
        };
    };
    updateAttributeName?: string;
    updateAttributes?: {
        updateAttributesValues: {
            fieldName?: string;
            fieldValue?: string;
        }[];
    };
    updateAttributeValue?: string;
    upsertAttributes?: {
        upsertAttributesValues: {
            fieldName?: string;
            fieldValue?: string;
        }[];
    };
}

Properties§

Source§

readonly additionalFields?:
    | {
        emailAttachments?: {
            attachment: { binaryPropertyName?: string };
        };
        emailTags?: { tags: { tag?: string } };
        receipientsBCC?: { receipientBcc: { bcc?: string } };
        receipientsCC?: { receipientCc: { cc?: string } };
    }
    | {
        emailAttachments?: {
            attachment: { binaryPropertyName?: string };
        };
        emailTags?: { tags: { tag?: string } };
        templateParameters?: {
            parameterValues: { parameters?: string };
        };
    }

Additional fields to add Default: {}

Source§

readonly attributeCategory?:
    | "calculated"
    | "category"
    | "global"
    | "normal"
    | "transactional"

Category of the attribute Default: "normal"

Source§

readonly attributeCategoryList?: {
    categoryEnumeration?: {
        attributesValues: {
            attributeCategoryLabel?: string;
            attributeCategoryValue?: number;
        }[];
    };
}

Default: {}

Source§

readonly attributeName?: string

Name of the attribute

Source§

readonly attributeType?: "boolean" | "text" | "date" | "float"

Attribute Type

Source§

readonly attributeValue?: string

Value of the attribute

Source§

readonly createContactAttributes?: {
    attributesValues: {
        fieldName?: string;
        fieldValue?: string;
    }[];
}

Array of attributes to be added Default: {} Type options: {"multipleValues":true}

Source§

readonly deleteAttributeCategory?:
    | "calculated"
    | "category"
    | "global"
    | "normal"
    | "transactional"

Category of the attribute Default: "normal"

Source§

readonly deleteAttributeName?: string

Name of the attribute

Source§

readonly email?: string

Email of the sender

Source§

readonly filters?: { modifiedSince?: string }

Default: {}

Source§

readonly htmlContent?: string

HTML content of the message

Source§

readonly id?: string

ID of the sender to delete

Source§

readonly identifier?: string

Email (urlencoded) OR ID of the contact OR its SMS attribute value

Source§

readonly limit?: number

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

Source§

readonly name?: string

Name of the sender

Source§

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

Default: "create"

Source§

readonly options?: { sort?: "asc" | "desc" }

Default: {}

Source§

readonly receipients?: string

Source§

readonly resource?: "contact" | "email" | "attribute" | "sender"

Default: "email"

Source§

readonly returnAll?: boolean

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

Source§

readonly sender?: string

Source§

readonly sendHTML?: boolean

Source§

readonly subject?: string

Subject of the email

Source§

readonly templateId?: string

Type options: {"loadOptions":{"routing":{"request":{"method":"GET","url":"/v3/smtp/templates","qs":{"templateStatus":true,"limit":1000,"offset":0,"sort":"desc"}},"output":{"postReceive":[{"type":"rootProperty","properties":{"property":"templates"}},{"type":"setKeyValue","properties":{"name":"={{$responseItem.name}}","value":"={{$responseItem.id}}"}},{"type":"sort","properties":{"key":"name"}}]}}}}

Source§

readonly textContent?: string

Text content of the message

Source§

readonly updateAttributeCategory?: "calculated" | "category" | "global"

Category of the attribute Default: "calculated"

Source§

readonly updateAttributeCategoryList?: {
    updateCategoryEnumeration?: {
        updateAttributesValues: {
            attributeCategoryLabel?: string;
            attributeCategoryValue?: number;
        }[];
    };
}

List of the values and labels that the attribute can take Default: {}

Source§

readonly updateAttributeName?: string

Name of the existing attribute

Source§

readonly updateAttributes?: {
    updateAttributesValues: {
        fieldName?: string;
        fieldValue?: string;
    }[];
}

Array of attributes to be updated Default: {} Type options: {"multipleValues":true}

Source§

readonly updateAttributeValue?: string

Value of the attribute to update

Source§

readonly upsertAttributes?: {
    upsertAttributesValues: {
        fieldName?: string;
        fieldValue?: string;
    }[];
}

Array of attributes to be updated Default: {} Type options: {"multipleValues":true}