- Category: email newsletters
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 57
- Triggers: 0
- Slug:
BIGMAILER - Version: 20261101_00
Tools
Create Brand
Create Brand
BIGMAILER_CREATE_BRANDTool 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.Input Parameters
Output
Create Brand Property
Create Brand Property
BIGMAILER_CREATE_BRAND_PROPERTYTool 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.Input Parameters
Output
Create Bulk Campaign
Create Bulk Campaign
BIGMAILER_CREATE_BULK_CAMPAIGNTool 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.Input Parameters
Output
Create Contact
Create Contact
BIGMAILER_CREATE_CONTACTTool 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.Input Parameters
Output
Create Contact Batch
Create Contact Batch
BIGMAILER_CREATE_CONTACT_BATCHUpload a batch of 1–1,000 contacts to be created or updated in a BigMailer brand. Supports custom fields, list assignments, and unsubscribe operations; contacts are processed asynchronously and a batch ID is returned for tracking.Input Parameters
Output
Create Field
Create Field
BIGMAILER_CREATE_FIELDTool 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.Input Parameters
Output
Create List
Create List
BIGMAILER_CREATE_LISTCreates 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.Input Parameters
Output
Create Segment
Create Segment
BIGMAILER_CREATE_SEGMENTTool 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.Input Parameters
Output
Create Suppression List
Create Suppression List
BIGMAILER_CREATE_SUPPRESSION_LISTTool 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.Input Parameters
Output
Create Template
Create Template
BIGMAILER_CREATE_TEMPLATECreate an email or page template in a BigMailer brand using HTML for reusable email designs or landing pages, including bulk campaign HTML. The template is shared with all brands in the account by default; sharing can be disabled.Input Parameters
Output
Create Transactional Campaign
Create Transactional Campaign
BIGMAILER_CREATE_TRANSACTIONAL_CAMPAIGNCreates 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.Input Parameters
Output
Create User
Create User
BIGMAILER_CREATE_USERTool 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.Input Parameters
Output
Delete Brand Property
Delete Brand Property
Delete Contact
Delete Contact
Delete Custom Field
Delete Custom Field
BIGMAILER_DELETE_FIELDDeletes 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.Input Parameters
Output
Delete List
Delete List
Delete Segment
Delete Segment
Delete Template
Delete Template
BIGMAILER_DELETE_TEMPLATETool 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.Input Parameters
Output
Delete User
Delete User
Get Brand
Get Brand
Get Brand Property
Get Brand Property
Get Bulk Campaign
Get Bulk Campaign
Get Contact
Get Contact
Get Contact Batch Status
Get Contact Batch Status
Get Custom Field
Get Custom Field
Get List
Get List
Get Segment
Get Segment
Get Suppression List
Get Suppression List
Get Template
Get Template
BIGMAILER_GET_TEMPLATETool 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.Input Parameters
Output
Get Transactional Campaign
Get Transactional Campaign
BIGMAILER_GET_TRANSACTIONAL_CAMPAIGNTool 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.Input Parameters
Output
Get User
Get User
Get User Information
Get User Information
List All Brands
List All Brands
List Brand Properties
List Brand Properties
List Bulk Campaigns
List Bulk Campaigns
BIGMAILER_LIST_BULK_CAMPAIGNSTool 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.Input Parameters
xyz123, your subsequent call can include cursor=xyz123 in order to fetch the next page of the list.Output
List Connections
List Connections
BIGMAILER_LIST_CONNECTIONSTool 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.Input Parameters
Output
List Contacts
List Contacts
BIGMAILER_LIST_CONTACTSTool 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.Input Parameters
Output
List Fields
List Fields
List Contact Lists
List Contact Lists
BIGMAILER_LIST_LISTSTool 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.Input Parameters
Output
List Message Types
List Message Types
BIGMAILER_LIST_MESSAGE_TYPESTool 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.Input Parameters
Output
List Segments
List Segments
BIGMAILER_LIST_SEGMENTSList segments for a specific brand in BigMailer, returning one page with pagination information. Segments organize and filter contacts based on conditions like campaign activity or field values.Input Parameters
cursor defines your place in the list. For instance, if you make a list request and receive 100 objects along with cursor xyz123, your subsequent call can include cursor=xyz123 in order to fetch the next page of the list.Output
List Senders
List Senders
List Suppression Lists
List Suppression Lists
BIGMAILER_LIST_SUPPRESSION_LISTSList suppression lists for a specific brand, with pagination via cursor and limit parameters. Suppression lists contain contacts to exclude from campaigns.Input Parameters
xyz123, your subsequent call can include cursor=xyz123 in order to fetch the next page of the listOutput
List Templates
List Templates
BIGMAILER_LIST_TEMPLATESLists a page of templates for a specified BigMailer brand, including email and page templates. Returns pagination information for retrieving subsequent pages.Input Parameters
Output
List Transactional Campaigns
List Transactional Campaigns
BIGMAILER_LIST_TRANSACTIONAL_CAMPAIGNSTool 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.Input Parameters
xyz123, your subsequent call can include cursor=xyz123 in order to fetch the next page of the list.Output
List Users
List Users
Update Brand
Update Brand
BIGMAILER_UPDATE_BRANDTool 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.Input Parameters
Output
Update Brand Property
Update Brand Property
BIGMAILER_UPDATE_BRAND_PROPERTYTool 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.Input Parameters
Output
Update Bulk Campaign
Update Bulk Campaign
BIGMAILER_UPDATE_BULK_CAMPAIGNUpdate an existing BigMailer bulk campaign’s name, subject, content, recipients, scheduling, or tracking settings. Requires the brand ID, campaign ID, and name; optional settings are sent when provided, and setting ready to true can send or schedule the campaign.Input Parameters
Output
Update Contact
Update Contact
BIGMAILER_UPDATE_CONTACTUpdate an existing BigMailer contact’s details, field values, list memberships, and unsubscribe settings. Field values, list IDs, and unsubscribe IDs support add, replace, and remove modes; each defaults to replace.Input Parameters
Output
Update Field
Update Field
BIGMAILER_UPDATE_FIELDTool 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.Input Parameters
Output
Update List
Update List
Update Segment
Update Segment
BIGMAILER_UPDATE_SEGMENTTool 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.Input Parameters
Output
Update Template
Update Template
BIGMAILER_UPDATE_TEMPLATETool 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.Input Parameters
Output
Update Transactional Campaign
Update Transactional Campaign
BIGMAILER_UPDATE_TRANSACTIONAL_CAMPAIGNTool 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.Input Parameters
Output
Update User
Update User
BIGMAILER_UPDATE_USERTool 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.Input Parameters
Output
Upsert Contact
Upsert Contact
BIGMAILER_UPSERT_CONTACTTool 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).