Interface ActiveCampaignNodeParameters

Source
interface ActiveCampaignNodeParameters {
    abandonedDate?: string;
    account?: number;
    accountContactId?: number;
    accountId?: number;
    additionalFields?:
        | { description?: string }
        | {
            accountUrl?: string;
            fields?: {
                property: {
                    customFieldId?: string;
                    fieldValue?: string;
                }[];
            };
        }
        | { jobTitle?: string }
        | {
            fieldValues?: {
                property: { field?: string; value?: string }[];
            };
            firstName?: string;
            lastName?: string;
            phone?: string;
        }
        | {
            datetime?: string;
            email?: string;
            email_like?: string;
            exclude?: string;
            "filters[created_after]"?: string;
            "filters[created_before]"?: string;
            "filters[updated_after]"?: string;
            "filters[updated_before]"?: string;
            formid?: string;
            listid?: string;
            orderBy?: | "orders[cdate]"
            | "orders[email]"
            | "orders[first_name]"
            | "orders[last_name]"
            | "orders[name]"
            | "orders[score]";
            search?: string;
            segmentid?: string;
            seriesid?: string;
            status?: 0
            | 1
            | -1
            | 3
            | 2;
            tagid?: string;
            waitid?: string;
        }
        | {
            description?: string;
            percent?: number;
            status?: number;
        }
        | {
            discountAmount?: number;
            externalUpdatedDate?: string;
            orderNumber?: string;
            orderUrl?: string;
            shippingAmount?: number;
            shippingMethod?: string;
            taxAmount?: number;
        }
        | { acceptsMarketing?: boolean };
    connectionid?: string | number;
    connectionId?: number;
    contact?: number;
    contactId?: number;
    contactTagId?: number;
    currency?:
        | ""
        | "eur"
        | "usd"
        | "gbp"
        | "chf"
        | "cny"
        | "aed"
        | "afn"
        | "all"
        | "amd"
        | "ang"
        | "aoa"
        | "ars"
        | "aud"
        | "awg"
        | "azn"
        | "bam"
        | "bbd"
        | "bdt"
        | "bgn"
        | "bhd"
        | "bif"
        | "bmd"
        | "bnd"
        | "bob"
        | "brl"
        | "bsd"
        | "btc"
        | "btn"
        | "bwp"
        | "byn"
        | "bzd"
        | "cad"
        | "cdf"
        | "clf"
        | "clp"
        | "cnh"
        | "cop"
        | "crc"
        | "cuc"
        | "cup"
        | "cve"
        | "czk"
        | "djf"
        | "dkk"
        | "dop"
        | "dzd"
        | "egp"
        | "ern"
        | "etb"
        | "fjd"
        | "fkp"
        | "gel"
        | "ggp"
        | "ghs"
        | "gip"
        | "gmd"
        | "gnf"
        | "gtq"
        | "gyd"
        | "hkd"
        | "hnl"
        | "hrk"
        | "htg"
        | "huf"
        | "idr"
        | "ils"
        | "imp"
        | "inr"
        | "iqd"
        | "irr"
        | "isk"
        | "jep"
        | "jmd"
        | "jod"
        | "jpy"
        | "kes"
        | "kgs"
        | "khr"
        | "kmf"
        | "kpw"
        | "krw"
        | "kwd"
        | "kyd"
        | "kzt"
        | "lak"
        | "lbp"
        | "lkr"
        | "lrd"
        | "lsl"
        | "lyd"
        | "mad"
        | "mdl"
        | "mga"
        | "mkd"
        | "mmk"
        | "mnt"
        | "mop"
        | "mro"
        | "mru"
        | "mur"
        | "mvr"
        | "mwk"
        | "mxn"
        | "myr"
        | "mzn"
        | "nad"
        | "ngn"
        | "nio"
        | "nok"
        | "npr"
        | "nzd"
        | "omr"
        | "pab"
        | "pen"
        | "pgk"
        | "php"
        | "pkr"
        | "pln"
        | "pyg"
        | "qar"
        | "ron"
        | "rsd"
        | "rub"
        | "rwf"
        | "sar"
        | "sbd"
        | "scr"
        | "sdg"
        | "sek"
        | "sgd"
        | "shp"
        | "sll"
        | "sos"
        | "srd"
        | "ssp"
        | "std"
        | "stn"
        | "svc"
        | "syp"
        | "szl"
        | "thb"
        | "tjs"
        | "tmt"
        | "tnd"
        | "top"
        | "try"
        | "ttd"
        | "twd"
        | "tzs"
        | "uah"
        | "ugx"
        | "uyu"
        | "uzs"
        | "vef"
        | "vnd"
        | "vuv"
        | "wst"
        | "xaf"
        | "xag"
        | "xau"
        | "xcd"
        | "xdr"
        | "xof"
        | "xpd"
        | "xpf"
        | "xpt"
        | "yer"
        | "zar"
        | "zmw"
        | "zwl";
    customerid?: number;
    dealId?: number;
    dealNote?: string;
    dealNoteId?: number;
    ecommerceCustomerId?: number;
    email?: string;
    externalcheckoutid?: string;
    externalCreatedDate?: string;
    externalid?: string;
    filters?: { search?: string };
    group?: string;
    limit?: number;
    linkUrl?: string;
    listId?: number;
    logoUrl?: string;
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete"
        | "createNote"
        | "updateNote"
        | "getByProductId"
        | "getByOrderId";
    orderId?: number;
    orderProducts?: {
        category?: string;
        description?: string;
        externalid?: string;
        imageUrl?: string;
        name?: string;
        price?: number;
        productUrl?: string;
        quantity?: number;
        sku?: string;
    };
    owner?: string;
    procuctId?: number;
    resource?: | "tag"
    | "account"
    | "accountContact"
    | "connection"
    | "contact"
    | "contactList"
    | "contactTag"
    | "deal"
    | "ecommerceCustomer"
    | "ecommerceOrder"
    | "ecommerceOrderProducts"
    | "list";
    returnAll?: boolean;
    service?: string;
    simple?: boolean;
    source?: number;
    stage?: string;
    tagId?: string
    | number;
    tagType?: "contact" | "template";
    title?: string;
    totalPrice?: number;
    updateFields?:
        | { description?: string; tag?: string }
        | {
            accountUrl?: string;
            fields?: {
                property: {
                    customFieldId?: string;
                    fieldValue?: string;
                }[];
            };
            name?: string;
        }
        | { jobTitle?: string }
        | {
            email?: string;
            fieldValues?: {
                property: { field?: string; value?: string }[];
            };
            firstName?: string;
            lastName?: string;
            phone?: string;
        }
        | {
            contact?: number;
            currency?: | ""
            | "eur"
            | "usd"
            | "gbp"
            | "chf"
            | "cny"
            | "aed"
            | "afn"
            | "all"
            | "amd"
            | "ang"
            | "aoa"
            | "ars"
            | "aud"
            | "awg"
            | "azn"
            | "bam"
            | "bbd"
            | "bdt"
            | "bgn"
            | "bhd"
            | "bif"
            | "bmd"
            | "bnd"
            | "bob"
            | "brl"
            | "bsd"
            | "btc"
            | "btn"
            | "bwp"
            | "byn"
            | "bzd"
            | "cad"
            | "cdf"
            | "clf"
            | "clp"
            | "cnh"
            | "cop"
            | "crc"
            | "cuc"
            | "cup"
            | "cve"
            | "czk"
            | "djf"
            | "dkk"
            | "dop"
            | "dzd"
            | "egp"
            | "ern"
            | "etb"
            | "fjd"
            | "fkp"
            | "gel"
            | "ggp"
            | "ghs"
            | "gip"
            | "gmd"
            | "gnf"
            | "gtq"
            | "gyd"
            | "hkd"
            | "hnl"
            | "hrk"
            | "htg"
            | "huf"
            | "idr"
            | "ils"
            | "imp"
            | "inr"
            | "iqd"
            | "irr"
            | "isk"
            | "jep"
            | "jmd"
            | "jod"
            | "jpy"
            | "kes"
            | "kgs"
            | "khr"
            | "kmf"
            | "kpw"
            | "krw"
            | "kwd"
            | "kyd"
            | "kzt"
            | "lak"
            | "lbp"
            | "lkr"
            | "lrd"
            | "lsl"
            | "lyd"
            | "mad"
            | "mdl"
            | "mga"
            | "mkd"
            | "mmk"
            | "mnt"
            | "mop"
            | "mro"
            | "mru"
            | "mur"
            | "mvr"
            | "mwk"
            | "mxn"
            | "myr"
            | "mzn"
            | "nad"
            | "ngn"
            | "nio"
            | "nok"
            | "npr"
            | "nzd"
            | "omr"
            | "pab"
            | "pen"
            | "pgk"
            | "php"
            | "pkr"
            | "pln"
            | "pyg"
            | "qar"
            | "ron"
            | "rsd"
            | "rub"
            | "rwf"
            | "sar"
            | "sbd"
            | "scr"
            | "sdg"
            | "sek"
            | "sgd"
            | "shp"
            | "sll"
            | "sos"
            | "srd"
            | "ssp"
            | "std"
            | "stn"
            | "svc"
            | "syp"
            | "szl"
            | "thb"
            | "tjs"
            | "tmt"
            | "tnd"
            | "top"
            | "try"
            | "ttd"
            | "twd"
            | "tzs"
            | "uah"
            | "ugx"
            | "uyu"
            | "uzs"
            | "vef"
            | "vnd"
            | "vuv"
            | "wst"
            | "xaf"
            | "xag"
            | "xau"
            | "xcd"
            | "xdr"
            | "xof"
            | "xpd"
            | "xpf"
            | "xpt"
            | "yer"
            | "zar"
            | "zmw"
            | "zwl";
            description?: string;
            group?: string;
            owner?: string;
            percent?: number;
            stage?: string;
            status?: number;
            title?: string;
            value?: number;
        }
        | {
            externalid?: string;
            linkUrl?: string;
            logoUrl?: string;
            name?: string;
            service?: string;
            status?: number;
            syncStatus?: number;
        }
        | {
            abandonedDate?: string;
            connectionid?: number;
            currency?: | ""
            | "eur"
            | "usd"
            | "gbp"
            | "chf"
            | "cny"
            | "aed"
            | "afn"
            | "all"
            | "amd"
            | "ang"
            | "aoa"
            | "ars"
            | "aud"
            | "awg"
            | "azn"
            | "bam"
            | "bbd"
            | "bdt"
            | "bgn"
            | "bhd"
            | "bif"
            | "bmd"
            | "bnd"
            | "bob"
            | "brl"
            | "bsd"
            | "btc"
            | "btn"
            | "bwp"
            | "byn"
            | "bzd"
            | "cad"
            | "cdf"
            | "clf"
            | "clp"
            | "cnh"
            | "cop"
            | "crc"
            | "cuc"
            | "cup"
            | "cve"
            | "czk"
            | "djf"
            | "dkk"
            | "dop"
            | "dzd"
            | "egp"
            | "ern"
            | "etb"
            | "fjd"
            | "fkp"
            | "gel"
            | "ggp"
            | "ghs"
            | "gip"
            | "gmd"
            | "gnf"
            | "gtq"
            | "gyd"
            | "hkd"
            | "hnl"
            | "hrk"
            | "htg"
            | "huf"
            | "idr"
            | "ils"
            | "imp"
            | "inr"
            | "iqd"
            | "irr"
            | "isk"
            | "jep"
            | "jmd"
            | "jod"
            | "jpy"
            | "kes"
            | "kgs"
            | "khr"
            | "kmf"
            | "kpw"
            | "krw"
            | "kwd"
            | "kyd"
            | "kzt"
            | "lak"
            | "lbp"
            | "lkr"
            | "lrd"
            | "lsl"
            | "lyd"
            | "mad"
            | "mdl"
            | "mga"
            | "mkd"
            | "mmk"
            | "mnt"
            | "mop"
            | "mro"
            | "mru"
            | "mur"
            | "mvr"
            | "mwk"
            | "mxn"
            | "myr"
            | "mzn"
            | "nad"
            | "ngn"
            | "nio"
            | "nok"
            | "npr"
            | "nzd"
            | "omr"
            | "pab"
            | "pen"
            | "pgk"
            | "php"
            | "pkr"
            | "pln"
            | "pyg"
            | "qar"
            | "ron"
            | "rsd"
            | "rub"
            | "rwf"
            | "sar"
            | "sbd"
            | "scr"
            | "sdg"
            | "sek"
            | "sgd"
            | "shp"
            | "sll"
            | "sos"
            | "srd"
            | "ssp"
            | "std"
            | "stn"
            | "svc"
            | "syp"
            | "szl"
            | "thb"
            | "tjs"
            | "tmt"
            | "tnd"
            | "top"
            | "try"
            | "ttd"
            | "twd"
            | "tzs"
            | "uah"
            | "ugx"
            | "uyu"
            | "uzs"
            | "vef"
            | "vnd"
            | "vuv"
            | "wst"
            | "xaf"
            | "xag"
            | "xau"
            | "xcd"
            | "xdr"
            | "xof"
            | "xpd"
            | "xpf"
            | "xpt"
            | "yer"
            | "zar"
            | "zmw"
            | "zwl";
            customerid?: number;
            discountAmount?: number;
            email?: string;
            externalcheckoutid?: string;
            externalid?: string;
            externalupdatedDate?: string;
            externalUpdatedDate?: string;
            orderNumber?: string;
            orderProducts?: {
                category?: string;
                description?: string;
                externalid?: string;
                imageUrl?: string;
                name?: string;
                price?: number;
                productUrl?: string;
                quantity?: number;
                sku?: string;
            };
            orderUrl?: string;
            shippingAmount?: number;
            shippingMethod?: string;
            source?: number;
            taxAmount?: number;
            totalPrice?: number;
        }
        | {
            acceptsMarketing?: boolean;
            connectionid?: string;
            email?: string;
            externalid?: string;
        };
    updateIfExists?: boolean;
    value?: number;
}

Properties§

Source§

readonly abandonedDate?: string

The date the cart was abandoned. REQUIRED ONLY IF INCLUDING EXTERNALCHECKOUTID.

Source§

readonly account?: number

Source§

readonly accountContactId?: number

ID of the account contact to delete

Source§

readonly accountId?: number

ID of the account to update

Source§

readonly additionalFields?:
    | { description?: string }
    | {
        accountUrl?: string;
        fields?: {
            property: {
                customFieldId?: string;
                fieldValue?: string;
            }[];
        };
    }
    | { jobTitle?: string }
    | {
        fieldValues?: {
            property: { field?: string; value?: string }[];
        };
        firstName?: string;
        lastName?: string;
        phone?: string;
    }
    | {
        datetime?: string;
        email?: string;
        email_like?: string;
        exclude?: string;
        "filters[created_after]"?: string;
        "filters[created_before]"?: string;
        "filters[updated_after]"?: string;
        "filters[updated_before]"?: string;
        formid?: string;
        listid?: string;
        orderBy?: | "orders[cdate]"
        | "orders[email]"
        | "orders[first_name]"
        | "orders[last_name]"
        | "orders[name]"
        | "orders[score]";
        search?: string;
        segmentid?: string;
        seriesid?: string;
        status?: 0
        | 1
        | -1
        | 3
        | 2;
        tagid?: string;
        waitid?: string;
    }
    | {
        description?: string;
        percent?: number;
        status?: number;
    }
    | {
        discountAmount?: number;
        externalUpdatedDate?: string;
        orderNumber?: string;
        orderUrl?: string;
        shippingAmount?: number;
        shippingMethod?: string;
        taxAmount?: number;
    }
    | { acceptsMarketing?: boolean }

Default: {}

Source§

readonly connectionid?: string | number

The ID of the connection from which this order originated

Source§

readonly connectionId?: number

ID of the connection to update

Source§

readonly contact?: number

Source§

readonly contactId?: number

Source§

readonly contactTagId?: number

ID of the contact tag to delete

Source§

readonly currency?:
    | ""
    | "eur"
    | "usd"
    | "gbp"
    | "chf"
    | "cny"
    | "aed"
    | "afn"
    | "all"
    | "amd"
    | "ang"
    | "aoa"
    | "ars"
    | "aud"
    | "awg"
    | "azn"
    | "bam"
    | "bbd"
    | "bdt"
    | "bgn"
    | "bhd"
    | "bif"
    | "bmd"
    | "bnd"
    | "bob"
    | "brl"
    | "bsd"
    | "btc"
    | "btn"
    | "bwp"
    | "byn"
    | "bzd"
    | "cad"
    | "cdf"
    | "clf"
    | "clp"
    | "cnh"
    | "cop"
    | "crc"
    | "cuc"
    | "cup"
    | "cve"
    | "czk"
    | "djf"
    | "dkk"
    | "dop"
    | "dzd"
    | "egp"
    | "ern"
    | "etb"
    | "fjd"
    | "fkp"
    | "gel"
    | "ggp"
    | "ghs"
    | "gip"
    | "gmd"
    | "gnf"
    | "gtq"
    | "gyd"
    | "hkd"
    | "hnl"
    | "hrk"
    | "htg"
    | "huf"
    | "idr"
    | "ils"
    | "imp"
    | "inr"
    | "iqd"
    | "irr"
    | "isk"
    | "jep"
    | "jmd"
    | "jod"
    | "jpy"
    | "kes"
    | "kgs"
    | "khr"
    | "kmf"
    | "kpw"
    | "krw"
    | "kwd"
    | "kyd"
    | "kzt"
    | "lak"
    | "lbp"
    | "lkr"
    | "lrd"
    | "lsl"
    | "lyd"
    | "mad"
    | "mdl"
    | "mga"
    | "mkd"
    | "mmk"
    | "mnt"
    | "mop"
    | "mro"
    | "mru"
    | "mur"
    | "mvr"
    | "mwk"
    | "mxn"
    | "myr"
    | "mzn"
    | "nad"
    | "ngn"
    | "nio"
    | "nok"
    | "npr"
    | "nzd"
    | "omr"
    | "pab"
    | "pen"
    | "pgk"
    | "php"
    | "pkr"
    | "pln"
    | "pyg"
    | "qar"
    | "ron"
    | "rsd"
    | "rub"
    | "rwf"
    | "sar"
    | "sbd"
    | "scr"
    | "sdg"
    | "sek"
    | "sgd"
    | "shp"
    | "sll"
    | "sos"
    | "srd"
    | "ssp"
    | "std"
    | "stn"
    | "svc"
    | "syp"
    | "szl"
    | "thb"
    | "tjs"
    | "tmt"
    | "tnd"
    | "top"
    | "try"
    | "ttd"
    | "twd"
    | "tzs"
    | "uah"
    | "ugx"
    | "uyu"
    | "uzs"
    | "vef"
    | "vnd"
    | "vuv"
    | "wst"
    | "xaf"
    | "xag"
    | "xau"
    | "xcd"
    | "xdr"
    | "xof"
    | "xpd"
    | "xpf"
    | "xpt"
    | "yer"
    | "zar"
    | "zmw"
    | "zwl"

The currency of the deal in 3-character ISO format Default: "eur"

Source§

readonly customerid?: number

The ID of the customer associated with this order

Source§

readonly dealId?: number

ID of the deal to update

Source§

readonly dealNote?: string

The content of the deal note

Source§

readonly dealNoteId?: number

The ID of the deal note

Source§

readonly ecommerceCustomerId?: number

ID of the E-commerce customer to update

Source§

readonly email?: string

The email of the contact to create

Source§

readonly externalcheckoutid?: string

The ID of the cart in the external service. ONLY REQUIRED IF EXTERNALID IS NOT INCLUDED.

Source§

readonly externalCreatedDate?: string

The date the order was placed

Source§

readonly externalid?: string

The ID of the account in the external service

Source§

readonly filters?: { search?: string }

Default: {}

Source§

readonly group?: string

The pipeline ID of the deal

Source§

readonly limit?: number

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

Source§

readonly linkUrl?: string

The URL to a page where the integration with the external service can be managed in the third-party's website

Source§

readonly listId?: number

Source§

readonly logoUrl?: string

The URL to a logo image for the external service

Source§

readonly name?: string

Name of the new tag

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "createNote"
    | "updateNote"
    | "getByProductId"
    | "getByOrderId"

Default: "create"

Source§

readonly orderId?: number

The ID of the e-commerce order

Source§

readonly orderProducts?: {
    category?: string;
    description?: string;
    externalid?: string;
    imageUrl?: string;
    name?: string;
    price?: number;
    productUrl?: string;
    quantity?: number;
    sku?: string;
}

All ordered products Default: {} Type options: {"multipleValues":true,"multipleValueButtonText":"Add product"}

Source§

readonly owner?: string

The owner ID of the deal

Source§

readonly procuctId?: number

The ID of the product you'd like returned

Source§

readonly resource?:
    | "tag"
    | "account"
    | "accountContact"
    | "connection"
    | "contact"
    | "contactList"
    | "contactTag"
    | "deal"
    | "ecommerceCustomer"
    | "ecommerceOrder"
    | "ecommerceOrderProducts"
    | "list"

Default: "contact"

Source§

readonly returnAll?: boolean

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

Source§

readonly service?: string

The name of the service

Source§

readonly simple?: boolean

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

Source§

readonly source?: number

The order source code (0 - will not trigger automations, 1 - will trigger automations)

Source§

readonly stage?: string

The stage ID of the deal

Source§

readonly tagId?: string | number

ID of the tag to update

Source§

readonly tagType?: "contact" | "template"

Tag-type of the new tag Default: "contact"

Source§

readonly title?: string

The title of the deal

Source§

readonly totalPrice?: number

The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

Source§

readonly updateFields?:
    | { description?: string; tag?: string }
    | {
        accountUrl?: string;
        fields?: {
            property: {
                customFieldId?: string;
                fieldValue?: string;
            }[];
        };
        name?: string;
    }
    | { jobTitle?: string }
    | {
        email?: string;
        fieldValues?: {
            property: { field?: string; value?: string }[];
        };
        firstName?: string;
        lastName?: string;
        phone?: string;
    }
    | {
        contact?: number;
        currency?: | ""
        | "eur"
        | "usd"
        | "gbp"
        | "chf"
        | "cny"
        | "aed"
        | "afn"
        | "all"
        | "amd"
        | "ang"
        | "aoa"
        | "ars"
        | "aud"
        | "awg"
        | "azn"
        | "bam"
        | "bbd"
        | "bdt"
        | "bgn"
        | "bhd"
        | "bif"
        | "bmd"
        | "bnd"
        | "bob"
        | "brl"
        | "bsd"
        | "btc"
        | "btn"
        | "bwp"
        | "byn"
        | "bzd"
        | "cad"
        | "cdf"
        | "clf"
        | "clp"
        | "cnh"
        | "cop"
        | "crc"
        | "cuc"
        | "cup"
        | "cve"
        | "czk"
        | "djf"
        | "dkk"
        | "dop"
        | "dzd"
        | "egp"
        | "ern"
        | "etb"
        | "fjd"
        | "fkp"
        | "gel"
        | "ggp"
        | "ghs"
        | "gip"
        | "gmd"
        | "gnf"
        | "gtq"
        | "gyd"
        | "hkd"
        | "hnl"
        | "hrk"
        | "htg"
        | "huf"
        | "idr"
        | "ils"
        | "imp"
        | "inr"
        | "iqd"
        | "irr"
        | "isk"
        | "jep"
        | "jmd"
        | "jod"
        | "jpy"
        | "kes"
        | "kgs"
        | "khr"
        | "kmf"
        | "kpw"
        | "krw"
        | "kwd"
        | "kyd"
        | "kzt"
        | "lak"
        | "lbp"
        | "lkr"
        | "lrd"
        | "lsl"
        | "lyd"
        | "mad"
        | "mdl"
        | "mga"
        | "mkd"
        | "mmk"
        | "mnt"
        | "mop"
        | "mro"
        | "mru"
        | "mur"
        | "mvr"
        | "mwk"
        | "mxn"
        | "myr"
        | "mzn"
        | "nad"
        | "ngn"
        | "nio"
        | "nok"
        | "npr"
        | "nzd"
        | "omr"
        | "pab"
        | "pen"
        | "pgk"
        | "php"
        | "pkr"
        | "pln"
        | "pyg"
        | "qar"
        | "ron"
        | "rsd"
        | "rub"
        | "rwf"
        | "sar"
        | "sbd"
        | "scr"
        | "sdg"
        | "sek"
        | "sgd"
        | "shp"
        | "sll"
        | "sos"
        | "srd"
        | "ssp"
        | "std"
        | "stn"
        | "svc"
        | "syp"
        | "szl"
        | "thb"
        | "tjs"
        | "tmt"
        | "tnd"
        | "top"
        | "try"
        | "ttd"
        | "twd"
        | "tzs"
        | "uah"
        | "ugx"
        | "uyu"
        | "uzs"
        | "vef"
        | "vnd"
        | "vuv"
        | "wst"
        | "xaf"
        | "xag"
        | "xau"
        | "xcd"
        | "xdr"
        | "xof"
        | "xpd"
        | "xpf"
        | "xpt"
        | "yer"
        | "zar"
        | "zmw"
        | "zwl";
        description?: string;
        group?: string;
        owner?: string;
        percent?: number;
        stage?: string;
        status?: number;
        title?: string;
        value?: number;
    }
    | {
        externalid?: string;
        linkUrl?: string;
        logoUrl?: string;
        name?: string;
        service?: string;
        status?: number;
        syncStatus?: number;
    }
    | {
        abandonedDate?: string;
        connectionid?: number;
        currency?: | ""
        | "eur"
        | "usd"
        | "gbp"
        | "chf"
        | "cny"
        | "aed"
        | "afn"
        | "all"
        | "amd"
        | "ang"
        | "aoa"
        | "ars"
        | "aud"
        | "awg"
        | "azn"
        | "bam"
        | "bbd"
        | "bdt"
        | "bgn"
        | "bhd"
        | "bif"
        | "bmd"
        | "bnd"
        | "bob"
        | "brl"
        | "bsd"
        | "btc"
        | "btn"
        | "bwp"
        | "byn"
        | "bzd"
        | "cad"
        | "cdf"
        | "clf"
        | "clp"
        | "cnh"
        | "cop"
        | "crc"
        | "cuc"
        | "cup"
        | "cve"
        | "czk"
        | "djf"
        | "dkk"
        | "dop"
        | "dzd"
        | "egp"
        | "ern"
        | "etb"
        | "fjd"
        | "fkp"
        | "gel"
        | "ggp"
        | "ghs"
        | "gip"
        | "gmd"
        | "gnf"
        | "gtq"
        | "gyd"
        | "hkd"
        | "hnl"
        | "hrk"
        | "htg"
        | "huf"
        | "idr"
        | "ils"
        | "imp"
        | "inr"
        | "iqd"
        | "irr"
        | "isk"
        | "jep"
        | "jmd"
        | "jod"
        | "jpy"
        | "kes"
        | "kgs"
        | "khr"
        | "kmf"
        | "kpw"
        | "krw"
        | "kwd"
        | "kyd"
        | "kzt"
        | "lak"
        | "lbp"
        | "lkr"
        | "lrd"
        | "lsl"
        | "lyd"
        | "mad"
        | "mdl"
        | "mga"
        | "mkd"
        | "mmk"
        | "mnt"
        | "mop"
        | "mro"
        | "mru"
        | "mur"
        | "mvr"
        | "mwk"
        | "mxn"
        | "myr"
        | "mzn"
        | "nad"
        | "ngn"
        | "nio"
        | "nok"
        | "npr"
        | "nzd"
        | "omr"
        | "pab"
        | "pen"
        | "pgk"
        | "php"
        | "pkr"
        | "pln"
        | "pyg"
        | "qar"
        | "ron"
        | "rsd"
        | "rub"
        | "rwf"
        | "sar"
        | "sbd"
        | "scr"
        | "sdg"
        | "sek"
        | "sgd"
        | "shp"
        | "sll"
        | "sos"
        | "srd"
        | "ssp"
        | "std"
        | "stn"
        | "svc"
        | "syp"
        | "szl"
        | "thb"
        | "tjs"
        | "tmt"
        | "tnd"
        | "top"
        | "try"
        | "ttd"
        | "twd"
        | "tzs"
        | "uah"
        | "ugx"
        | "uyu"
        | "uzs"
        | "vef"
        | "vnd"
        | "vuv"
        | "wst"
        | "xaf"
        | "xag"
        | "xau"
        | "xcd"
        | "xdr"
        | "xof"
        | "xpd"
        | "xpf"
        | "xpt"
        | "yer"
        | "zar"
        | "zmw"
        | "zwl";
        customerid?: number;
        discountAmount?: number;
        email?: string;
        externalcheckoutid?: string;
        externalid?: string;
        externalupdatedDate?: string;
        externalUpdatedDate?: string;
        orderNumber?: string;
        orderProducts?: {
            category?: string;
            description?: string;
            externalid?: string;
            imageUrl?: string;
            name?: string;
            price?: number;
            productUrl?: string;
            quantity?: number;
            sku?: string;
        };
        orderUrl?: string;
        shippingAmount?: number;
        shippingMethod?: string;
        source?: number;
        taxAmount?: number;
        totalPrice?: number;
    }
    | {
        acceptsMarketing?: boolean;
        connectionid?: string;
        email?: string;
        externalid?: string;
    }

The fields to update Default: {}

Source§

readonly updateIfExists?: boolean

Whether to update user if it exists already. If not set and user exists it will error instead.

Source§

readonly value?: number

The value of the deal in cents