Skip to main content
Server path: /mailbluster | Type: Application | PCID required: Yes

Tools

ToolDescription
mailbluster_create_fieldCreate a custom field
mailbluster_create_leadCreate a lead
mailbluster_create_orderCreate an order
mailbluster_create_productCreate a product
mailbluster_delete_fieldDelete a custom field
mailbluster_delete_orderDelete an order
mailbluster_delete_productDelete a product
mailbluster_get_fieldGet a custom field
mailbluster_get_orderGet an order
mailbluster_get_productGet a product
mailbluster_list_fieldsList custom fields
mailbluster_list_ordersList orders
mailbluster_list_productsList products
mailbluster_update_fieldUpdate a custom field
mailbluster_update_orderUpdate an order
mailbluster_update_productUpdate a product

mailbluster_create_field

Create a custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldLabelstringYesDisplay label for the custom field
fieldMergeTagstringYesMerge tag identifier for the field (used in email templates)

mailbluster_create_lead

Create a lead Parameters:
ParameterTypeRequiredDefaultDescription
doubleOptInbooleanNoWhether to send a double opt-in confirmation email
emailstringYesEmail address of the lead
firstNamestringNoFirst name of the lead
ipAddressstringNoIP address of the lead
lastNamestringNoLast name of the lead
metaobjectNoCustom field values as key-value pairs
overrideExistingbooleanNoIf true, overrides existing lead data if the email already exists
subscribedbooleanNoWhether the lead is subscribed. Defaults to true.
tagsstring[]NoTags to assign to the lead
timezonestringNoTimezone of the lead (e.g., America/New_York)

mailbluster_create_order

Create an order Parameters:
ParameterTypeRequiredDefaultDescription
campaignIdstringNoID of the campaign associated with this order
currencystringYesCurrency code (e.g., USD, EUR)
customerobjectYesCustomer information for the order
idstringYesUnique identifier for the order
itemsobject[]YesLine items in the order (required, can be empty array)
totalPricenumberYesTotal price of the order

mailbluster_create_product

Create a product Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the product
namestringYesName of the product

mailbluster_delete_field

Delete a custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdstringYesID of the custom field to delete

mailbluster_delete_order

Delete an order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesID of the order to delete

mailbluster_delete_product

Delete a product Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesID of the product to delete

mailbluster_get_field

Get a custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdstringYesID of the custom field

mailbluster_get_order

Get an order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesID of the order to retrieve

mailbluster_get_product

Get a product Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesID of the product to retrieve

mailbluster_list_fields

List custom fields

mailbluster_list_orders

List orders

mailbluster_list_products

List products

mailbluster_update_field

Update a custom field Parameters:
ParameterTypeRequiredDefaultDescription
fieldIdstringYesID of the custom field to update
fieldLabelstringNoDisplay label for the custom field
fieldMergeTagstringNoMerge tag identifier for the field

mailbluster_update_order

Update an order Parameters:
ParameterTypeRequiredDefaultDescription
orderIdstringYesID of the order to update
campaignIdstringNoID of the campaign associated with this order
currencystringNoCurrency code
customerobjectNoCustomer information for the order
itemsobject[]NoLine items in the order
totalPricenumberNoTotal price of the order

mailbluster_update_product

Update a product Parameters:
ParameterTypeRequiredDefaultDescription
productIdstringYesID of the product to update
namestringNoName of the product