# Bigmailer

BigMailer is an email marketing platform designed for managing multiple brands, offering features like white-labeling, automation, and integration with Amazon SES.

- **Category:** email newsletters
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 57
- **Triggers:** 0
- **Slug:** `BIGMAILER`
- **Version:** 20260307_00

## Tools

### Create Brand

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | URL of a website associated with the brand |
| `logo` | string | No | A base64 encoded JPEG, PNG, or GIF image identified with the brand |
| `name` | string | Yes | Name of the brand. Length must be between 1 and 50 characters. |
| `from_name` | string | Yes | Default name used in the From: header in campaigns sent from this brand |
| `from_email` | string | Yes | Default email used in the From: header in campaigns sent from this brand. Must be a valid email format. |
| `connection_id` | string | No | ID of the connection used to send emails. Must be a valid UUID format. |
| `contact_limit` | integer | No | The maximum number of contacts the brand is allowed to contain. Must be a multiple of 1000. |
| `max_soft_bounces` | integer | No | 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. |
| `unsubscribe_text` | string | No | A message displayed to contacts on the brand unsubscribe page |
| `bounce_danger_percent` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Brand Property

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the brand property (1-50 characters, must contain at least one non-whitespace character) |
| `is_html` | boolean | No | If the value of the property is HTML or not |
| `brand_id` | string | Yes | ID of the brand to create a property in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `string_value` | string | No | The value substituted for the tag in a template (max 100000 characters) |
| `merge_tag_name` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Bulk Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | HTML body of the email |
| `name` | string | Yes | Name of the campaign |
| `text` | string | No | Text body of the email |
| `ready` | boolean | No | Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true |
| `preview` | string | No | Copy shown following your subject line in many email clients |
| `subject` | string | No | Subject line for the campaign |
| `brand_id` | string | Yes | ID of the brand to create the campaign in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `list_ids` | array | No | An array of list IDs to send the campaign to |
| `reply_to` | object | No | Reply-to email address and name for the campaign |
| `segment_id` | string | No | ID of a segment used to filter the lists of contacts the campaign is sent to |
| `link_params` | string | No | Additional query string parameters to add to all links in the template |
| `template_id` | string | No | A template ID to use to populate the HTML body of the email |
| `track_opens` | boolean | No | True to enable open tracking (HTML campaigns only) |
| `from_address` | object | No | From email address and name for the campaign |
| `track_clicks` | boolean | No | True to enable click tracking in HTML links |
| `scheduled_for` | integer | No | Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately |
| `recipient_name` | string | No | Name of the recipient. Use merge tags to make it more personal and avoid spam filters |
| `message_type_id` | string | No | ID of the message type of the campaign |
| `throttling_type` | string ("none" | "burst") | No | Set to 'none' to send the campaign as fast as possible. Set to 'burst' to send the campaign in small batches over time |
| `excluded_list_ids` | array | No | An array of list IDs to exclude from the campaign. Any contacts on these lists will not be sent the campaign |
| `throttling_amount` | integer | No | Number of emails to send in each batch. Must be a multiple of 1000. Required if throttling_type is 'burst' |
| `throttling_period` | integer ("900" | "1800" | "3600" | "7200") | No | 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) |
| `track_text_clicks` | boolean | No | True to enable click tracking in text links |
| `suppression_list_id` | string | No | ID of a suppression list. Any emails in the suppression list will not be sent the campaign |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the contact (1-100 characters) |
| `brand_id` | string | Yes | The UUID of the brand to create the contact in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `list_ids` | array | No | IDs of lists (UUIDs) the contact should be added to |
| `field_values` | array | No | 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. |
| `validate_email` | boolean | No | 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. |
| `unsubscribe_all` | boolean | No | Set to true to unsubscribe the contact from all future campaigns, regardless of message type. Defaults to false. |
| `unsubscribe_ids` | array | No | IDs of message types (UUIDs) the contact should be unsubscribed from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact Batch

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | List of contacts to add (minimum 1, maximum 1000 contacts per batch) |
| `brand_id` | string | Yes | ID of the brand to upsert the contacts in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `validate_emails` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Field

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the field (1-50 characters, must not be only whitespace) |
| `type` | string ("date" | "integer" | "text") | Yes | Type of the field |
| `brand_id` | string | Yes | ID of the brand to create a field in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `sample_value` | string | No | A value used for the field when sending test campaigns (maximum 50 characters) |
| `merge_tag_name` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the list to create (must be between 1 and 50 characters) |
| `brand_id` | string | Yes | The UUID of the brand to create the list in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the segment (max 50 characters) |
| `brand_id` | string | Yes | The UUID of the brand to create the segment in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `operator` | string ("all" | "any") | Yes | Logical operator: 'all' if all conditions must match, 'any' if at least one condition must match |
| `conditions` | array | Yes | Array of conditions that the segment must satisfy. See BigMailer documentation for available condition types and operators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Suppression List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file containing email addresses in the first column of each row. |
| `brand_id` | string | Yes | ID of the brand to upload a suppression list in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | Yes | HTML body of the template |
| `name` | string | Yes | Name of the template (must be between 1 and 50 characters) |
| `type` | string ("email" | "page") | Yes | Type of campaigns the template may be used with |
| `brand_id` | string | Yes | ID of the brand to create the template in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `shared_with_account` | boolean | No | True if the template is shared with all brands in the account, false otherwise |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Transactional Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the transactional campaign |
| `subject` | string | Yes | Email subject line |
| `brand_id` | string | Yes | The UUID of the brand under which to create the campaign. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `reply_to` | object | No | Reply-to configuration. When provided, both email and name fields are required. |
| `from_name` | string | Yes | Sender's name |
| `from_email` | string | Yes | Sender's email address |
| `description` | string | No | Campaign description |
| `html_content` | string | Yes | HTML content of the email |
| `text_content` | string | No | Plain text version of the email content |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("admin" | "account_manager" | "brand_manager" | "campaign_manager" | "template_manager") | Yes | 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). |
| `email` | string | Yes | User's email address. Must be a valid email format. |
| `allowed_brands` | array | No | 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. |
| `invitation_message` | string | No | A message to include in the invitation email sent to the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Brand Property

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand |
| `brand_property_id` | string | Yes | ID of the brand property to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand to delete the contact from |
| `contact_id` | string | Yes | ID or email address of the contact to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field

**Slug:** `BIGMAILER_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | The UUID of the brand that contains the field to delete. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `field_id` | string | Yes | The UUID of the custom field to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list to delete |
| `brand_id` | string | Yes | ID of the brand that owns the list. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand that contains the segment |
| `segment_id` | string | Yes | ID of the segment to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Template

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand that contains the template. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `template_id` | string | Yes | ID of the template to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Brand

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand to get (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Brand Property

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand |
| `brand_property_id` | string | Yes | ID of the brand property |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `campaign_id` | string | Yes | ID of the bulk campaign to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand to get the contact from |
| `contact_id` | string | Yes | ID or email address of the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Batch Status

**Slug:** `BIGMAILER_GET_CONTACT_BATCH`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | ID of the contact batch |
| `brand_id` | string | Yes | ID of the brand to get the contact batch from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Field

**Slug:** `BIGMAILER_GET_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand |
| `field_id` | string | Yes | ID of the field |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | ID of the list |
| `brand_id` | string | Yes | ID of the brand |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segment

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand |
| `segment_id` | string | Yes | ID of the segment |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Suppression List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand |
| `suppression_list_id` | string | Yes | ID of the suppression list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand to get the template from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `template_id` | string | Yes | ID of the template to retrieve (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transactional Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `brand_id` | string | Yes | ID of the brand. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `campaign_id` | string | Yes | ID of the transactional campaign to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | ID of the user to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Information

**Slug:** `BIGMAILER_GET_USER_INFO`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All Brands

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of brands to return per page (default is determined by API) |
| `cursor` | string | No | Pagination cursor from a previous response to fetch the next page of results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Brand Properties

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of brand properties to return per page (between 1 and 100, default is 10) |
| `cursor` | string | No | Pagination cursor from a previous response to fetch the next page of results |
| `brand_id` | string | Yes | The unique identifier of the brand to retrieve properties from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bulk Campaigns

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100 |
| `cursor` | string | No | 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. |
| `brand_id` | string | Yes | ID of the brand to retrieve bulk campaigns from (UUID) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Connections

**Slug:** `BIGMAILER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100 |
| `cursor` | string | No | A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results |
| `list_id` | string | No | The id of a list. Only contacts in this list are returned |
| `brand_id` | string | Yes | ID of the brand to list contacts from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fields

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of fields to return per page, between 1 and 100 (default is 10) |
| `cursor` | string | No | Pagination cursor from a previous response to fetch the next page of results |
| `brand_id` | string | Yes | ID of the brand to retrieve custom fields from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Lists

**Slug:** `BIGMAILER_LIST_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100 |
| `cursor` | string | No | 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. |
| `brand_id` | string | Yes | ID of the brand to retrieve contact lists from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Message Types

**Slug:** `BIGMAILER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Segments

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100. |
| `cursor` | string | No | 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. |
| `brand_id` | string | Yes | ID of the brand to retrieve segments from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Senders

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of senders to return (between 1 and 100, default is 10) |
| `cursor` | string | No | Pagination cursor from a previous response to fetch the next page of results |
| `brand_id` | string | Yes | ID of the brand to retrieve senders from (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Suppression Lists

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100 |
| `cursor` | string | No | 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 |
| `brand_id` | string | Yes | ID of the brand to retrieve suppression lists from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100. |
| `cursor` | string | No | A cursor for use in pagination. Pass the cursor value from a previous response to fetch the next page of results. |
| `brand_id` | string | Yes | ID of the brand to retrieve templates from. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transactional Campaigns

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | A limit on the number of objects to be returned, between 1 and 100 |
| `cursor` | string | No | 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. |
| `brand_id` | string | Yes | ID of the brand to retrieve transactional campaigns from (UUID) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `BIGMAILER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Brand

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | URL of a website associated with the brand |
| `logo` | string | No | A base64 encoded JPEG, PNG, or GIF image identified with the brand |
| `name` | string | No | Name of the brand (1-50 characters) |
| `brand_id` | string | Yes | ID of the brand to update (UUID format) |
| `from_name` | string | No | Default name used in the From: header in campaigns sent from this brand |
| `from_email` | string | No | Default email used in the From: header in campaigns sent from this brand |
| `connection_id` | string | No | ID of the connection used to send emails (UUID format) |
| `contact_limit` | integer | No | The maximum number of contacts the brand is allowed to contain |
| `max_soft_bounces` | integer | No | 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. |
| `unsubscribe_text` | string | No | A message displayed to contacts on the brand unsubscribe page |
| `bounce_danger_percent` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Brand Property

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the brand property |
| `is_html` | boolean | No | If the value of the property is html or not. |
| `brand_id` | string | Yes | ID of the brand to update a brand property in |
| `string_value` | string | No | The value substituted for the tag in a template. |
| `merge_tag_name` | string | No | 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. |
| `brand_property_id` | string | Yes | ID of the brand property to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bulk Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | HTML body of the email. |
| `name` | string | Yes | Name of the campaign |
| `text` | string | No | Text body of the email. |
| `ready` | boolean | No | Set to true to send or schedule the campaign. The campaign will not be sent or scheduled until activated by setting ready to true. |
| `preview` | string | No | Copy shown following your subject line in many email clients. |
| `subject` | string | No | Subject line for the campaign |
| `brand_id` | string | Yes | ID of the brand to update a campaign in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `list_ids` | array | No | An array of list ids to send the campaign to. |
| `reply_to` | object | No | Reply to email address and name |
| `segment_id` | string | No | ID of a segment used to filter the lists of contacts the campaign is sent to. |
| `campaign_id` | string | Yes | ID of the campaign to update |
| `link_params` | string | No | Additional query string parameters to add to all links in the template. |
| `template_id` | string | No | A template id to use to populate the HTML body of the email. |
| `track_opens` | boolean | No | True to enable open tracking (HTML campaigns only). |
| `from_address` | object | No | From email address and name for the campaign |
| `track_clicks` | boolean | No | True to enable click tracking in HTML links. |
| `scheduled_for` | integer | No | Time at which to send the campaign. Measured in seconds since the UNIX epoch. Omit to send the campaign immediately. |
| `recipient_name` | string | No | Name of the recipient. Use merge tags to make it more personal and avoid spam filters. |
| `message_type_id` | string | No | ID of the message type of the campaign. |
| `throttling_type` | string ("none" | "burst") | No | Set to none to send the campaign as fast as possible. Set to burst to send the campaign in small batches over time. |
| `excluded_list_ids` | array | No | An array of list ids to exclude from the campaign. Any contacts on these lists will not be sent the campaign. |
| `throttling_amount` | integer | No | Number of emails to send in each batch. Must be a multiple of 1000. Required if throttling_type is burst. |
| `throttling_period` | integer ("900" | "1800" | "3600" | "7200") | No | 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). |
| `track_text_clicks` | boolean | No | True to enable click tracking in text links. |
| `suppression_list_id` | string | No | ID of a suppression list. Any emails in the suppression list will not be sent the campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `BIGMAILER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Field

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the field. Must be between 1 and 50 characters and must not be only whitespace. |
| `brand_id` | string | Yes | ID of the brand to update a field in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `field_id` | string | Yes | ID of the field to update |
| `sample_value` | string | No | A value used for the field when sending test campaigns. Maximum length: 50 characters. |
| `merge_tag_name` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update List

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New name for the list (1-50 characters) |
| `list_id` | string | Yes | ID of the list to update |
| `brand_id` | string | Yes | ID of the brand to update a list in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segment

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the segment |
| `brand_id` | string | Yes | ID of the brand that owns the segment. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `operator` | string ("all" | "any") | No | Operator for combining segment conditions |
| `conditions` | array | No | Array of conditions that define the segment. See BigMailer documentation for detailed condition structure. |
| `segment_id` | string | Yes | ID of the segment to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | HTML body of the template |
| `name` | string | No | Name of the template (must be between 1 and 50 characters) |
| `type` | string ("email" | "page") | No | Type of campaigns the template may be used with |
| `brand_id` | string | Yes | ID of the brand to update a template in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `template_id` | string | Yes | ID of the template to update (UUID format). Use BIGMAILER_LIST_TEMPLATES to get valid template IDs. |
| `shared_with_account` | boolean | No | True if the template is shared with all brands in the account, false otherwise |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Transactional Campaign

**Slug:** `BIGMAILER_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `BIGMAILER_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("admin" | "account_manager" | "brand_manager" | "campaign_manager" | "template_manager") | No | The user role determines what actions the user may perform. See BigMailer docs for user roles and permissions. |
| `email` | string | No | User's email address |
| `user_id` | string | Yes | ID of the user to update (UUID format) |
| `allowed_brands` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Contact

**Slug:** `BIGMAILER_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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the contact (required, must be valid email format, max 100 characters) |
| `brand_id` | string | Yes | ID of the brand to create or update the contact in. Use BIGMAILER_LIST_ALL_BRANDS to get valid brand IDs. |
| `list_ids` | array | No | List of list IDs (UUIDs) to add the contact to |
| `field_values` | array | No | 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. |
| `validate_email` | string ("true" | "false") | No | Enum for email validation option. |
| `unsubscribe_all` | boolean | No | Set to true to unsubscribe the contact from all future campaigns, regardless of message type (default: false) |
| `unsubscribe_ids` | array | No | List of message type IDs (UUIDs) the contact should be unsubscribed from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |