Bigmailer

Tools (57)

• Create Brand

  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.

  Inputs: url, logo, name, from_name, from_email, connection_id, contact_limit, max_soft_bounces, unsubscribe_text, bounce_danger_percent

• Create Brand Property

  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.

  Inputs: name, is_html, brand_id, string_value, merge_tag_name

• Create Bulk Campaign

  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 to get valid brand IDs.

  Inputs: html, name, text, ready, preview, subject, brand_id, list_ids, reply_to, segment_id, link_params, template_id, track_opens, from_address, track_clicks, scheduled_for, recipient_name, message_type_id, throttling_type, excluded_list_ids, throttling_amount, throttling_period, track_text_clicks, suppression_list_id

• Create Contact

  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.

  Inputs: email, brand_id, list_ids, field_values, validate_email, unsubscribe_all, unsubscribe_ids

• Create Contact Batch

  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.

  Inputs: items, brand_id, validate_emails

• Create Field

  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.

  Inputs: name, type, brand_id, sample_value, merge_tag_name

• Create List

  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.

  Inputs: name, brand_id

• Create Segment

  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.

  Inputs: name, brand_id, operator, conditions

• Create Suppression List

  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.

  Inputs: file, brand_id

• Create Template

  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.

  Inputs: html, name, type, brand_id, shared_with_account

• Create Transactional Campaign

  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). Returns the unique ID of the created campaign on success.

  Inputs: name, subject, brand_id, reply_to, from_name, from_email, description, html_content, text_content

• Create User

  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.

  Inputs: role, email, allowed_brands, invitation_message

• Delete Brand Property

  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.

  Inputs: brand_id, brand_property_id

• Delete Contact

  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.

  Inputs: brand_id, contact_id

• Delete Custom Field

  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.

  Inputs: brand_id, field_id

• Delete List

  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.

  Inputs: list_id, brand_id

• Delete Segment

  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.

  Inputs: brand_id, segment_id

• Delete Template

  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.

  Inputs: brand_id, template_id

• Delete User

  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.

  Inputs: user_id

• Get Brand

  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.

  Inputs: brand_id

• Get Brand Property

  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.

  Inputs: brand_id, brand_property_id

• Get Bulk Campaign

  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.

  Inputs: brand_id, campaign_id

• Get Contact

  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.

  Inputs: brand_id, contact_id

• Get Contact Batch Status

  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.

  Inputs: batch_id, brand_id

• Get Custom Field

  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.

  Inputs: brand_id, field_id

• Get List

  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.

  Inputs: list_id, brand_id

• Get Segment

  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.

  Inputs: brand_id, segment_id

• Get Suppression List

  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.

  Inputs: brand_id, suppression_list_id

• Get Template

  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.

  Inputs: brand_id, template_id

• Get Transactional Campaign

  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.

  Inputs: brand_id, campaign_id

• Get User

  Tool to retrieve detailed information about a specific user by their ID. Use when you need to get user details including email, role, activation status, and brand permissions.

  Inputs: user_id

• Get User Information

  This tool retrieves information about the authenticated user in BigMailer using the GET /me endpoint. It requires only authentication and no additional parameters, making it ideal for verifying API connectivity and retrieving essential user details.

• List All Brands

  This tool retrieves a list of all brands associated with the authenticated BigMailer account. It allows users to view and manage their brands. The operation is executed via a simple GET request to the /brands endpoint and requires proper authentication using the X-API-Key header. The response is a JSON array containing information such as Brand ID, Brand name, and other related details.

  Inputs: limit, cursor

• List Brand Properties

  Tool to retrieve a list of brand properties for a specific brand in BigMailer. Use when you need to view custom properties associated with a brand, such as merge tags and their values used in email campaigns.

  Inputs: limit, cursor, brand_id

• List Bulk Campaigns

  Tool to list bulk campaigns for a specified brand in BigMailer. Use when you need to retrieve all bulk email campaigns associated with a brand, including their status, statistics, and configuration. Supports pagination using cursor-based navigation for large result sets.

  Inputs: limit, cursor, brand_id

• List Connections

  Tool to list all connections in your BigMailer account. Use when you need to retrieve connections for email delivery (e.g., AWS SES). Supports pagination for accounts with many connections.

  Inputs: limit, cursor

• List Contacts

  Tool to list contacts for a brand in BigMailer. Use when you need to retrieve contacts from a specific brand, optionally filtered by list membership. Supports pagination for large contact lists.

  Inputs: limit, cursor, list_id, brand_id

• List Fields

  Tool to list custom fields for a brand in BigMailer. Use when you need to retrieve all custom fields defined for a specific brand, including field names, types, and merge tags.

  Inputs: limit, cursor, brand_id

• List Contact Lists

  Tool to retrieve all contact lists for a specified brand in BigMailer. Use when you need to view or manage contact lists within a brand, or when you need to get a list ID for other operations. Supports pagination for brands with many lists.

  Inputs: limit, cursor, brand_id

• List Message Types

  Tool to list message types for a specific brand in BigMailer. Use when you need to retrieve available message type categories that can be used for organizing and categorizing email campaigns. Supports filtering by type (user-created, account-level, or all) and pagination for large result sets.

  Inputs: type, limit, cursor, brand_id

• List Segments

  Tool to list segments for a brand in BigMailer. Use when you need to retrieve and view all segments associated with a specific brand. Segments are used to organize and filter contacts based on conditions like campaign activity or field values.

  Inputs: limit, cursor, brand_id

• List Senders

  Tool to list all senders configured for a specific brand in BigMailer. Use when you need to retrieve sender identities (domains or email addresses) associated with a brand, including their verification status and DNS configuration details.

  Inputs: limit, cursor, brand_id

• List Suppression Lists

  Tool to list suppression lists for a specific brand. Suppression lists contain contacts that should be excluded from campaigns. Use this to view and manage suppression lists associated with a brand. Supports pagination via cursor and limit parameters.

  Inputs: limit, cursor, brand_id

• List Templates

  Tool to list templates for a brand in BigMailer. Use when you need to retrieve all templates associated with a specific brand. Templates can be email or SMS templates used for campaigns and transactional messages.

  Inputs: limit, cursor, brand_id

• List Transactional Campaigns

  Tool to list transactional campaigns for a specified brand in BigMailer. Use when you need to retrieve all transactional email campaigns associated with a brand, including their status, statistics, and configuration. Supports pagination using cursor-based navigation for large result sets.

  Inputs: limit, cursor, brand_id

• List Users

  Tool to list all users in your BigMailer account. Use when you need to retrieve user information, check account access, or manage user permissions. Supports pagination for accounts with many users.

  Inputs: limit, cursor

• Update Brand

  Tool to update a brand in BigMailer. Use when you need to modify brand settings such as name, email defaults, contact limits, bounce settings, or branding elements. Only the fields provided in the request will be updated; unspecified fields retain their current values.

  Inputs: url, logo, name, brand_id, from_name, from_email, connection_id, contact_limit, max_soft_bounces, unsubscribe_text, bounce_danger_percent

• Update Brand Property

  Tool to update a brand property in BigMailer. Use when you need to modify properties of an existing brand, such as the property name, merge tag name, string value, or HTML flag. At least one of the optional fields must be provided.

  Inputs: name, is_html, brand_id, string_value, merge_tag_name, brand_property_id

• Update Bulk Campaign

  Tool to update an existing bulk campaign in BigMailer. Use when modifying campaign properties like name, subject, content, recipients, scheduling, or tracking settings. Only the name field is required; all other fields are optional and will only update if provided.

  Inputs: html, name, text, ready, preview, subject, brand_id, list_ids, reply_to, segment_id, campaign_id, link_params, template_id, track_opens, from_address, track_clicks, scheduled_for, recipient_name, message_type_id, throttling_type, excluded_list_ids, throttling_amount, throttling_period, track_text_clicks, suppression_list_id

• Update Contact

  Tool to update an existing contact in BigMailer. Use when you need to modify contact details, manage list subscriptions, or update field values. Supports multiple operation modes (add, replace, remove) for field_values, list_ids, and unsubscribe_ids.

  Inputs: email, brand_id, list_ids, contact_id, list_ids_op, field_values, field_values_op, unsubscribe_all, unsubscribe_ids, unsubscribe_ids_op

• Update Field

  Tool to update a custom field in BigMailer. Use when you need to modify the name, merge tag name, or sample value of an existing field within a brand. At least one of merge_tag_name, name, or sample_value must be provided.

  Inputs: name, brand_id, field_id, sample_value, merge_tag_name

• Update List

  Tool to update a list in BigMailer. Use when you need to rename an existing list within a brand. This action requires both the brand ID and list ID to identify the list to update.

  Inputs: name, list_id, brand_id

• Update Segment

  Tool to update an existing segment in BigMailer. Use when modifying segment properties such as name, operator logic, or conditions. At least one field (name, operator, or conditions) should be provided to update the segment.

  Inputs: name, brand_id, operator, conditions, segment_id

• Update Template

  Tool to update an existing email or page template in BigMailer. Use when you need to modify template properties such as name, HTML content, type, or sharing settings. Only the fields provided in the request will be updated; unspecified fields retain their current values.

  Inputs: html, name, type, brand_id, template_id, shared_with_account

• Update Transactional Campaign

  Tool to update a transactional campaign in BigMailer. Use when you need to modify campaign settings such as name, subject, content, tracking options, or activation status. Only the fields provided in the request will be updated; unspecified fields retain their current values.

  Inputs: html, name, text, ready, list_id, preview, subject, brand_id, reply_to, campaign_id, link_params, template_id, track_opens, from_address, track_clicks, recipient_name, message_type_id, track_text_clicks

• Update User

  Tool to update a user in BigMailer. Use when you need to modify user settings such as email, role, or allowed brands. Only the fields provided will be updated.

  Inputs: role, email, user_id, allowed_brands

• Upsert Contact

  Tool to create or update a contact in a BigMailer brand. Use when you need to add a new contact or update an existing contact's information. If a contact with the given email already exists, it will be updated; otherwise, a new contact will be created. Optionally validates email deliverability before adding (requires validation credits).

  Inputs: email, brand_id, list_ids, field_values, validate_email, unsubscribe_all, unsubscribe_ids