Bigmailer

Tool to create a new brand in BigMailer. Brands are used to organize email campaigns and define default sending settings. Requires at minimum a brand name, from_name, and from_email. Returns the unique UUID of the created brand.

Untrusted display-only summary

Tool to create a brand property in BigMailer. Use when you need to define a custom property for a brand that can be referenced in email templates via merge tags. The merge_tag_name allows the property to be used as *|TAG_NAME|* in templates.

Untrusted display-only summary

Tool to create a bulk email campaign in BigMailer. Use when you need to send marketing emails to multiple recipients. The campaign can be sent immediately or scheduled for later. Throttling options allow you to control send rate. At minimum, you must provide a brand_id and campaign name. Use BIGMAILER_LIST_ALL_BRANDS…

Untrusted display-only summary

Tool to create a new contact in BigMailer within a specified brand. Use when you need to add contacts to your mailing lists with optional custom fields and subscription settings. The contact's email address is required, and you can optionally add custom field values, assign to lists, and manage subscription status.

Untrusted display-only summary

Tool to create a batch of contacts in BigMailer for a specific brand. Use when you need to upload multiple contacts (1-1000) at once. Supports custom fields, list assignments, and unsubscribe operations. The batch is queued for asynchronous processing and returns a batch ID for tracking.

Untrusted display-only summary

Tool to create a custom field in a BigMailer brand. Custom fields allow you to store additional contact information (text, date, or integer values). Use when you need to add a new field to track contact data like company name, birthday, or loyalty points.

Untrusted display-only summary

Creates a new contact list within a specified brand in BigMailer. Use this to organize and segment contacts. The list must be associated with an existing brand. Use BIGMAILER_LIST_ALL_BRANDS to retrieve valid brand IDs before creating a list.

Untrusted display-only summary

Tool to create a segment in BigMailer for a specific brand. Segments allow filtering contacts based on conditions like campaign activity (opened, clicked) or custom field values. Use when you need to organize contacts into targeted groups for campaigns.

Untrusted display-only summary

Tool to upload a suppression list for a brand in BigMailer. Use when you need to add email addresses that should be excluded from campaigns. The file must be a CSV with email addresses in the first column of each row.

Untrusted display-only summary

Tool to create a new email or page template in BigMailer. Templates can be used with bulk campaigns to define the HTML structure. Use when you need to create reusable email designs or landing pages. The template can be shared across all brands in the account if desired.

Untrusted display-only summary

Creates a new transactional campaign within a specified brand in BigMailer. Transactional campaigns are used for sending automated emails like welcome emails, password resets, order confirmations, etc. The campaign must be associated with an existing brand (use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs). Return…

Untrusted display-only summary

Tool to create a new user in BigMailer. Use when you need to add team members with specific roles and permissions. Returns the unique UUID of the created user.

Untrusted display-only summary

Tool to delete a brand property from a brand in BigMailer. Use when you need to remove a custom property that was previously associated with a brand.

Untrusted display-only summary

Tool to delete a contact from a brand in BigMailer. Use when you need to remove a contact permanently from a brand's contact list.

Untrusted display-only summary

Deletes a custom field from a specified brand in BigMailer. Custom fields are used to store additional contact information. This action permanently removes the field and cannot be undone. Use this when you need to clean up unused fields or remove fields that are no longer needed.

Untrusted display-only summary

Tool to delete a list from BigMailer. Use when you need to permanently remove a list from a brand. Returns the ID of the deleted list upon success.

Untrusted display-only summary

Tool to delete a segment from a brand in BigMailer. Use when you need to remove a segment that is no longer needed. Returns the ID of the deleted segment on success.

Untrusted display-only summary

Tool to delete a template from BigMailer. Use when you need to permanently remove a template from a brand. Returns the ID of the deleted template upon success.

Untrusted display-only summary

Tool to delete a user from BigMailer. Use when you need to permanently remove a user from the system. Returns the ID of the deleted user upon success.

Untrusted display-only summary

Tool to retrieve detailed information about a specific brand by its ID. Use when you need to get brand configuration, email settings, bounce thresholds, or other brand properties.

Untrusted display-only summary

Tool to retrieve a specific brand property by its ID for a given brand. Use when you need to fetch details about a brand property, such as its name, merge tag name, value, or HTML status.

Untrusted display-only summary

Tool to retrieve detailed information about a specific bulk campaign in BigMailer. Use when you need to get campaign details including status, content, recipient lists, and performance metrics like opens, clicks, bounces, and unsubscribes.

Untrusted display-only summary

Tool to retrieve detailed information about a specific contact from BigMailer. Use when you need to fetch contact details including email, custom field values, list memberships, and engagement metrics.

Untrusted display-only summary

Tool to retrieve the status and results of a contact batch upload in BigMailer. Use when you need to check the processing status of a batch contact import or review the results of individual contacts in the batch.

Untrusted display-only summary

Tool to retrieve a custom field from a BigMailer brand. Use when you need to get details about a specific custom field including its ID, name, type, merge tag name, and sample value.

Untrusted display-only summary

Tool to retrieve details of a specific list within a brand. Use when you need to get information about a list such as its name, creation time, and whether it's the special system list containing all contacts.

Untrusted display-only summary

Tool to retrieve a specific segment from BigMailer by brand ID and segment ID. Use when you need to get details about a segment including its conditions and operator.

Untrusted display-only summary

Tool to retrieve details of a specific suppression list for a brand in BigMailer. Use when you need to get information about a suppression list including its file name, size, and creation timestamp.

Untrusted display-only summary

Tool to retrieve detailed information about a specific template by its ID. Use when you need to get template content, HTML body, type, creation time, or sharing settings.

Untrusted display-only summary

Tool to retrieve detailed information about a specific transactional campaign in BigMailer. Use when you need to get campaign details including status, content, tracking settings, and performance metrics like opens, clicks, bounces, and unsubscribes.

Untrusted display-only summary