Skip to main content
Bigmailer logo
  • Category: email newsletters
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 57
  • Triggers: 0
  • Slug: BIGMAILER
  • Version: 20261101_00

Tools

Slug: 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

string
URL of a website associated with the brand
A base64 encoded JPEG, PNG, or GIF image identified with the brand
string
required
Name of the brand. Length must be between 1 and 50 characters.
string
required
Default name used in the From: header in campaigns sent from this brand
string
required
Default email used in the From: header in campaigns sent from this brand. Must be a valid email format.
string
ID of the connection used to send emails. Must be a valid UUID format.
integer
The maximum number of contacts the brand is allowed to contain. Must be a multiple of 1000.
integer
The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces. Default is 12.
string
A message displayed to contacts on the brand unsubscribe page
integer
An integer percentage (1-15). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically. Default is 8.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the brand property (1-50 characters, must contain at least one non-whitespace character)
boolean
If the value of the property is HTML or not
string
required
ID of the brand to create a property in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
The value substituted for the tag in a template (max 100000 characters)
string
Name used to reference a brand property’s value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using |COMPANY_NAME| in a template. Must contain at least one non-whitespace character (max 50 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML body of the email
string
required
Name of the campaign
string
Text body of the email
boolean
Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true
string
Copy shown following your subject line in many email clients
string
Subject line for the campaign
string
required
ID of the brand to create the campaign in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
array
An array of list IDs to send the campaign to
object
Reply-to email address and name for the campaign
string
ID of a segment used to filter the lists of contacts the campaign is sent to
Additional query string parameters to add to all links in the template
string
A template ID to use to populate the HTML body of the email
boolean
True to enable open tracking (HTML campaigns only)
object
From email address and name for the campaign
boolean
True to enable click tracking in HTML links
integer
Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately
string
Name of the recipient. Use merge tags to make it more personal and avoid spam filters
string
ID of the message type of the campaign
string ("none" | "burst")
Set to ‘none’ to send the campaign as fast as possible. Set to ‘burst’ to send the campaign in small batches over time
array
An array of list IDs to exclude from the campaign. Any contacts on these lists will not be sent the campaign
integer
Number of emails to send in each batch. Must be a multiple of 1000. Required if throttling_type is ‘burst’
integer ("900" | "1800" | "3600" | "7200")
Time in seconds between sending each batch of emails. Required if throttling_type is ‘burst’. Must be one of: 900 (15 minutes), 1800 (30 minutes), 3600 (1 hour), or 7200 (2 hours)
boolean
True to enable click tracking in text links
string
ID of a suppression list. Any emails in the suppression list will not be sent the campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address of the contact (1-100 characters)
string
required
The UUID of the brand to create the contact in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
array
IDs of lists (UUIDs) the contact should be added to
array
Custom field values to save along with the contact. Each field must have exactly one of string, integer, or date. The name must match a field that exists in the brand.
boolean
Set to true to validate the email for deliverability before adding the contact. Validation credits must be purchased before using this feature. The API does not add the contact and returns an error if the email is undeliverable.
boolean
Set to true to unsubscribe the contact from all future campaigns, regardless of message type. Defaults to false.
array
IDs of message types (UUIDs) the contact should be unsubscribed from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of contacts to add (minimum 1, maximum 1000 contacts per batch)
string
required
ID of the brand to upsert the contacts in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
boolean
Set to true to validate emails for deliverability before adding contacts. Validation credits must be purchased before using this feature. Contacts with emails that do not validate will not be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the field (1-50 characters, must not be only whitespace)
string ("date" | "integer" | "text")
required
Type of the field
string
required
ID of the brand to create a field in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
A value used for the field when sending test campaigns (maximum 50 characters)
string
Name used to reference a field’s value via a template or the API. For example, if merge_tag_name is FIRST_NAME, the field can be referenced using |FIRST_NAME| in a template or {“name”: “FIRST_NAME”, “string”: ""} via the API. Maximum 50 characters, must not be only whitespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the list to create (must be between 1 and 50 characters)
string
required
The UUID of the brand to create the list in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the segment (max 50 characters)
string
required
The UUID of the brand to create the segment in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string ("all" | "any")
required
Logical operator: ‘all’ if all conditions must match, ‘any’ if at least one condition must match
array
required
Array of conditions that the segment must satisfy. See BigMailer documentation for available condition types and operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
CSV file containing email addresses in the first column of each row.
string
required
ID of the brand to upload a suppression list in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
HTML body of the template
string
required
Name of the template (must be between 1 and 50 characters)
string ("email" | "page")
required
Type of campaigns the template may be used with
string
required
ID of the brand to create the template in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
boolean
True if the template is shared with all brands in the account, false otherwise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the transactional campaign
string
required
Email subject line
string
required
The UUID of the brand under which to create the campaign. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
object
Reply-to configuration. When provided, both email and name fields are required.
string
required
Sender’s name
string
required
Sender’s email address
string
Campaign description
string
required
HTML content of the email
string
Plain text version of the email content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("admin" | "account_manager" | "brand_manager" | "campaign_manager" | "template_manager")
required
The user role determines what actions the user may perform. Choose from: admin (full access), account_manager, brand_manager (limited to specific brands), campaign_manager (limited to specific brands), or template_manager (limited to specific brands).
string
required
User’s email address. Must be a valid email format.
array
A list of brand IDs (UUIDs) the user is allowed to access. Only relevant if the role is brand_manager, campaign_manager, or template_manager. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
A message to include in the invitation email sent to the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_DELETE_BRAND_PROPERTYTool 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.

Input Parameters

string
required
ID of the brand
string
required
ID of the brand property to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_DELETE_CONTACTDelete a contact from a BigMailer brand using its contact ID or email address. The returned identifier echoes the supplied ID or email.

Input Parameters

string
required
ID of the brand to delete the contact from
string
required
ID or email address of the contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID of the brand that contains the field to delete. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
The UUID of the custom field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_DELETE_LISTDelete a list from a BigMailer brand without deleting its contacts. Returns the list ID upon success.

Input Parameters

string
required
ID of the list to delete
string
required
ID of the brand that owns the list. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_DELETE_SEGMENTTool 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.

Input Parameters

string
required
ID of the brand that contains the segment
string
required
ID of the segment to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the brand that contains the template. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_DELETE_USERDelete a BigMailer user by ID and return the ID upon success. The account owner cannot be deleted.

Input Parameters

string
required
ID of the user to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_BRANDTool 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.

Input Parameters

string
required
ID of the brand to get (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_BRAND_PROPERTYTool 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.

Input Parameters

string
required
ID of the brand
string
required
ID of the brand property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_BULK_CAMPAIGNTool 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.

Input Parameters

string
required
ID of the brand. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the bulk campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_CONTACTRetrieve a specific contact from a BigMailer brand by contact ID or email, including email, custom field values, list memberships, unsubscribe status, and bounce and complaint counts.

Input Parameters

string
required
ID of the brand to get the contact from
string
required
ID or email address of the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_CONTACT_BATCHTool 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.

Input Parameters

string
required
ID of the contact batch
string
required
ID of the brand to get the contact batch from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_FIELDTool 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.

Input Parameters

string
required
ID of the brand
string
required
ID of the field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_LISTTool 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.

Input Parameters

string
required
ID of the list
string
required
ID of the brand

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_SEGMENTTool 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.

Input Parameters

string
required
ID of the brand
string
required
ID of the segment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_SUPPRESSION_LISTTool 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.

Input Parameters

string
required
ID of the brand
string
required
ID of the suppression list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the brand to get the template from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the template to retrieve (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the brand. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the transactional campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_USERRetrieve a BigMailer user by ID to inspect their email, role, activation status, and available brand permissions.

Input Parameters

string
required
ID of the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_GET_USER_INFOThis 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_LIST_ALL_BRANDSList a page of brands associated with the authenticated BigMailer account via GET /brands. The response contains brand details, including IDs and names, along with pagination information for retrieving subsequent pages.

Input Parameters

integer
Maximum number of brands to return per page (default is determined by API)
string
Pagination cursor from a previous response to fetch the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_LIST_BRAND_PROPERTIESTool 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.

Input Parameters

integer
Maximum number of brand properties to return per page (between 1 and 100, default is 10)
string
Pagination cursor from a previous response to fetch the next page of results
string
required
The unique identifier of the brand to retrieve properties from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. 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.
string
required
ID of the brand to retrieve bulk campaigns from (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results
string
The id of a list. Only contacts in this list are returned
string
required
ID of the brand to list contacts from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_LIST_FIELDSList a page of custom fields for a specific BigMailer brand, including field names, types, and merge tags. Use the returned cursor to retrieve subsequent pages.

Input Parameters

integer
Maximum number of fields to return per page, between 1 and 100 (default is 10)
string
Pagination cursor from a previous response to fetch the next page of results
string
required
ID of the brand to retrieve custom fields from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. Defines your place in the list. Pass the cursor value from a previous response to fetch the next page of results.
string
required
ID of the brand to retrieve contact lists from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("all" | "account" | "user")
Filter results by message type. Options: ‘all’ (all types), ‘account’ (account-level types), ‘user’ (user-created types). Default is ‘user’.
integer
Maximum number of message types to return per page, between 1 and 100 (default: 10)
string
Pagination cursor from a previous response to fetch the next page of results
string
required
The UUID of the brand to retrieve message types from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100.
string
A cursor for use in pagination. 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.
string
required
ID of the brand to retrieve segments from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_LIST_SENDERSList a page of sender identities associated with a specific BigMailer brand, including verification status and any available DNS configuration details. Use the returned cursor to retrieve additional pages.

Input Parameters

integer
Maximum number of senders to return (between 1 and 100, default is 10)
string
Pagination cursor from a previous response to fetch the next page of results
string
required
ID of the brand to retrieve senders from (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. 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
string
required
ID of the brand to retrieve suppression lists from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100.
string
A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results.
string
required
ID of the brand to retrieve templates from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. 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.
string
required
ID of the brand to retrieve transactional campaigns from (UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_LIST_USERSList users in your BigMailer account to retrieve user information and review account access or permissions. Supports cursor pagination.

Input Parameters

integer
A limit on the number of objects to be returned, between 1 and 100
string
A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
URL of a website associated with the brand
string
A base64 encoded JPEG, PNG, or GIF image identified with the brand
string
Name of the brand (1-50 characters)
string
required
ID of the brand to update (UUID format)
string
Default name used in the From: header in campaigns sent from this brand
string
Default email used in the From: header in campaigns sent from this brand
string
ID of the connection used to send emails (UUID format)
integer
The maximum number of contacts the brand is allowed to contain
integer
The maximum number of times a contact can soft bounce before it is considered undeliverable. Set to 0 to remove the limit on soft bounces. Default is 12.
string
A message displayed to contacts on the brand unsubscribe page
integer
An integer percentage (1-15). If a bulk campaign in the brand reaches this threshold percent of bounces, it is paused automatically. Default is 8.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the brand property
boolean
If the value of the property is html or not.
string
required
ID of the brand to update a brand property in
string
The value substituted for the tag in a template.
string
Name used to reference a brand property’s value via a template. For example, if merge_tag_name is COMPANY_NAME, the field can be referenced using |COMPANY_NAME| in a template.
string
required
ID of the brand property to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML body of the email.
string
required
Name of the campaign
string
Text body of the email.
boolean
Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true.
string
Copy shown following your subject line in many email clients.
string
Subject line for the campaign
string
required
ID of the brand to update a campaign in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
array
An array of list ids to send the campaign to.
object
Reply to email address and name
string
ID of a segment used to filter the lists of contacts the campaign is sent to.
string
required
ID of the campaign to update
Additional query string parameters to add to all links in the template.
string
A template id to use to populate the HTML body of the email.
boolean
True to enable open tracking (HTML campaigns only).
object
From email address and name for the campaign
boolean
True to enable click tracking in HTML links.
integer
Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately.
string
Name of the recipient. Use merge tags to make it more personal and avoid spam filters.
string
ID of the message type of the campaign.
string ("none" | "burst")
Set to none to send the campaign as fast as possible. Set to burst to send the campaign in small batches over time.
array
An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign.
integer
Number of emails to send in each batch. Must be a multiple of 1000. Required if throttling_type is burst.
integer ("900" | "1800" | "3600" | "7200")
Time in seconds between sending each batch of emails. Required if throttling_type is burst. Valid values: 900 (15 min), 1800 (30 min), 3600 (1 hour), 7200 (2 hours).
boolean
True to enable click tracking in text links.
string
ID of a suppression list. Any emails in the suppression list will not be sent the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Email address of the contact
string
required
ID of the brand to update the contact in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
array
IDs of lists to manage for the contact
string
required
ID or email address of the contact to update
string ("add" | "remove" | "replace")
Controls how list_ids are applied. ‘add’ appends to existing, ‘replace’ replaces entire array, ‘remove’ removes supplied IDs.
array
Field values to update. Each field must have a name and exactly one of string, integer, or date.
string ("add" | "remove" | "replace")
Controls how field_values are applied. ‘add’ copies supplied values (overwrites duplicates), ‘replace’ replaces entire object, ‘remove’ removes supplied values.
boolean
Set to true to unsubscribe the contact from all future campaigns, regardless of message type.
array
IDs of message types to manage unsubscription for
string ("add" | "remove" | "replace")
Controls how unsubscribe_ids are applied. ‘add’ appends to existing, ‘replace’ replaces entire array, ‘remove’ removes supplied IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the field. Must be between 1 and 50 characters and must not be only whitespace.
string
required
ID of the brand to update a field in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the field to update
string
A value used for the field when sending test campaigns. Maximum length: 50 characters.
string
Name used to reference a field’s value via a template or the API. For example, if merge_tag_name is FIRST_NAME, the field can be referenced using |FIRST_NAME| in a template or via the API. Maximum length: 50 characters. Must not be only whitespace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BIGMAILER_UPDATE_LISTTool 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.

Input Parameters

string
required
New name for the list (1-50 characters)
string
required
ID of the list to update
string
required
ID of the brand to update a list in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Name of the segment
string
required
ID of the brand that owns the segment. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string ("all" | "any")
Operator for combining segment conditions
array
Array of conditions that define the segment. See BigMailer documentation for detailed condition structure.
string
required
ID of the segment to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML body of the template
string
Name of the template (must be between 1 and 50 characters)
string ("email" | "page")
Type of campaigns the template may be used with
string
required
ID of the brand to update a template in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
string
required
ID of the template to update (UUID format). Use BIGMAILER_LIST_TEMPLATES to get valid template IDs.
boolean
True if the template is shared with all brands in the account, false otherwise

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
HTML body of the email
string
required
Name of the campaign
string
Text body of the email
boolean
Set to true to activate the campaign. The campaign cannot be sent until activated by setting ready to true
string
ID of a list contacts sent the transactional campaign should be added to (UUID format)
string
Copy shown following your subject line in many email clients
string
Subject line for the campaign
string
required
ID of the brand containing the campaign (UUID format). Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
object
Reply-to email address and name
string
required
ID of the campaign to update (UUID format)
Additional query string parameters to add to all links in the template
string
A template id to use to populate the HTML body of the email (UUID format)
boolean
True to enable open tracking (HTML campaigns only)
object
From email address and name
boolean
True to enable click tracking in HTML links
string
Name of the recipient. Use merge tags to make it more personal and avoid spam filters
string
ID of the message type of the campaign (UUID format)
boolean
True to enable click tracking in text links

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("admin" | "account_manager" | "brand_manager" | "campaign_manager" | "template_manager")
The user role determines what actions the user may perform. See BigMailer docs for user roles and permissions.
string
User’s email address
string
required
ID of the user to update (UUID format)
array
A list of brand IDs (UUID format) the user is allowed to access. Only relevant if the role is brand_manager, campaign_manager, or template_manager.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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).

Input Parameters

string
required
Email address of the contact (required, must be valid email format, max 100 characters)
string
required
ID of the brand to create or update the contact in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs.
array
List of list IDs (UUIDs) to add the contact to
array
Field values to save with the contact. Each field must have exactly one of: string, integer, or date. The name must match a field tag that exists in the brand.
string ("true" | "false")
Enum for email validation option.
boolean
Set to true to unsubscribe the contact from all future campaigns, regardless of message type (default: false)
array
List of message type IDs (UUIDs) the contact should be unsubscribed from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not