Reference

Create Brand

Set up a new brand in BigMailer to organize your email campaigns and establish default sender information for your outreach efforts.

Create Brand Property

Create custom properties for your email brand that can be dynamically inserted into email templates using merge tags, allowing you to personalize messages with brand-specific information.

Delete Brand Property

Remove a custom property from your email brand profile to clean up outdated or unnecessary brand data. This helps keep your brand configuration organized and removes information that's no longer relevant to your email campaigns.

Get Brand

Retrieve detailed configuration and settings for a specific brand, including email preferences, bounce thresholds, and other brand properties to verify or audit your email sending setup.

Get Brand Property

Retrieve detailed information about a specific brand property, including its name, merge tag, value, and HTML formatting settings. Use this to access brand customization details you've set up in your email marketing campaigns.

List All Brands

Retrieve all brands connected to your BigMailer account to view and organize your brand information. Use this to manage multiple brand identities across your email marketing campaigns.

List Brand Properties

Retrieve all custom properties and merge tags associated with a brand in BigMailer, enabling you to see what personalization data is available for your email campaigns.

Update Brand

Modify your BigMailer brand settings including name, default email preferences, contact limits, bounce handling, and branding elements to keep your email marketing configuration current and aligned with your business needs.

Update Brand Property

Modify brand property details in BigMailer to keep your brand information current, including custom field names, merge tags, and values that personalize your email campaigns.

Create Bulk Campaign

Send marketing emails to multiple recipients at once with options to schedule delivery and control send rates. Perfect for reaching your audience with campaigns that can be customized and sent on your timeline.

Create Transactional Campaign

Set up automated email campaigns for transactional messages like confirmations, password resets, and notifications that are triggered by specific user actions. This enables you to maintain consistent customer communication without manual intervention.

Get Bulk Campaign

Retrieve complete details about a bulk email campaign including its status, content, recipient information, and performance metrics like opens, clicks, and bounces to track campaign effectiveness.

Get Transactional Campaign

Retrieve detailed information about a specific transactional campaign including its status, content, tracking settings, and performance metrics to monitor campaign effectiveness and delivery results.

List Bulk Campaigns

Retrieve all bulk email campaigns for your brand to view their performance, status, and settings in one place. This helps you track, analyze, and manage your email marketing efforts efficiently.

List Transactional Campaigns

Retrieve all transactional email campaigns associated with a brand to view their performance metrics, status, and settings in one place.

Update Bulk Campaign

Modify an existing bulk email campaign in BigMailer by updating properties such as subject line, content, recipient list, send schedule, or tracking preferences. Perfect for refining campaigns before sending or adjusting strategy based on early performance.

Update Transactional Campaign

Modify your transactional email campaign settings including subject lines, content, tracking preferences, and activation status without affecting unchanged fields.

List Connections

Retrieve all email delivery connections configured in your BigMailer account to manage and verify which services are available for sending campaigns.

Create Contact

Add new contacts to your BigMailer mailing lists with their email address and optional custom details like name, company, or subscription preferences.

List Contacts

Retrieve your email contacts from a specific brand in BigMailer, with optional filtering by mailing lists and support for large contact databases through pagination.

Update Contact

Modify existing contact information in BigMailer, including personal details, list subscriptions, and custom field values. Use this when you need to keep your subscriber database current or manage list preferences.

Upsert Contact

Create new contacts or update existing ones in your BigMailer brand with a single operation, automatically handling duplicates by email address. This ensures your contact database stays current without manual management or accidental duplicates.

Create Contact Batch

Upload multiple contacts (up to 1,000) to your email list at once with custom fields and list assignments for efficient bulk management.

Delete Contact

Permanently removes a contact from your mailing list, helping you maintain a clean and current subscriber database.

Get Contact

Retrieve detailed information about a specific contact from your BigMailer account, including their email, custom fields, list memberships, and engagement history.

Get Contact Batch Status

Track the progress and results of your bulk contact uploads in BigMailer, including success rates and any import errors that need attention.

Create Field

Add custom fields to your BigMailer contacts to track additional information like company details, dates, or numeric values beyond standard contact data. This enables you to organize and segment your audience based on personalized attributes.

Delete Custom Field

Permanently removes a custom field from your BigMailer brand to clean up your contact database. Use this when you need to eliminate unused data fields or reorganize your subscriber information structure.

Get Custom Field

Retrieve details about a specific custom field in your BigMailer brand, including its name, type, merge tag, and sample value. Use this to verify field configurations or understand how to reference custom fields in your email campaigns.

List Fields

Retrieve all custom fields set up for your email marketing brand, including field names, types, and merge tags for personalization. Use this to understand what subscriber data you can leverage in your campaigns.

Update Field

Modify custom field properties in BigMailer such as the field name, merge tag, or sample value to keep your email marketing data structures current and organized.

Create List

Create a new contact list in BigMailer to organize and segment your email subscribers by different categories or campaigns. This helps you manage targeted email communications more effectively.

Delete List

Permanently remove an email list from your BigMailer account when you no longer need to maintain or contact that audience segment.

Get List

Retrieve detailed information about a specific mailing list, including its name, creation date, and contact count. This helps you understand your list configuration and verify list settings before sending campaigns.

List Contact Lists

Retrieve all your email contact lists from BigMailer to view, manage, or access list IDs for your marketing campaigns. Helps you organize and reference your subscriber groups across your email marketing efforts.

Update List

Rename or modify an existing email list in BigMailer to keep your subscriber lists organized and reflect current segments or campaigns. This helps you maintain accurate naming conventions as your business needs evolve.

List Message Types

Retrieve the available message type categories for your brand in BigMailer to understand how emails are organized and segmented. This helps you manage your email campaigns more effectively by knowing what message type options you have.

Create Segment

Creates a targeted segment in BigMailer that groups contacts based on specific criteria like engagement history or custom field values, enabling you to send highly relevant campaigns to the right audience.

List Segments

Retrieve all audience segments you've created in BigMailer to organize and manage your contacts based on specific criteria. This helps you understand how your audience is segmented for targeted email campaigns.

Delete Segment

Remove an unused email segment from your BigMailer account to keep your contact lists organized and clean. This helps you maintain a streamlined email marketing setup by eliminating segments you no longer need.

Get Segment

Retrieve detailed information about a specific email segment including its targeting conditions and rules. This helps you understand how your audience is organized and segmented for targeted email campaigns.

Update Segment

Modify an existing email segment by updating its name, logic rules, or filtering conditions to keep your subscriber groups organized and targeted.

List Senders

Retrieve all configured email senders for your brand in BigMailer, including their verification status and DNS settings. Use this to manage which email addresses or domains are authorized to send messages on behalf of your business.

Create Suppression List

Upload a list of email addresses to exclude from your email campaigns, ensuring specific contacts don't receive marketing messages.

Get Suppression List

Retrieve details about a specific suppression list for your brand, including file information and when it was created, helping you manage which email addresses should be excluded from campaigns.

List Suppression Lists

Retrieve all suppression lists for your brand to see which contacts are excluded from your email campaigns. This helps you understand who's on your do-not-contact lists and manage your email sending compliance.

Create Template

Create reusable email or landing page templates in BigMailer that can be applied across multiple campaigns and brands. This allows you to maintain consistent design and messaging while saving time on repeated formatting work.

Delete Template

Permanently remove an email template from your BigMailer account when it's no longer needed or has been replaced by a newer version.

Get Template

Retrieve detailed information about a specific email template including its content, HTML structure, and settings. Use this to access template data for review, duplication, or integration with your email campaigns.

List Templates

Retrieve all email and SMS templates associated with your BigMailer brand to see what message designs are available for your campaigns. This helps you quickly find and reuse existing templates rather than creating new ones from scratch.

Update Template

Modify an existing email or page template in BigMailer by updating properties like name, HTML content, type, or sharing settings. Changes only apply to the fields you specify, leaving others unchanged.

Create User

Add new team members to your BigMailer account with specific roles and permissions, enabling them to collaborate on email campaigns and account management.

Delete User

Permanently remove a user account from your BigMailer email marketing platform. This operation returns the deleted user's ID for confirmation.

Get User

Retrieve detailed information about a specific user in your Bigmailer account, including their email, role, and access permissions.

Get User Information

Retrieves your account details and profile information from BigMailer to verify your connection and access key user settings. Use this to confirm your authentication is working and retrieve account-specific information needed for managing your email campaigns.

List Users

Retrieve all users in your BigMailer account to view team members, check who has access, and manage account permissions. Helpful for understanding your account structure and user activity.

Update User

Modify user details in BigMailer such as email address, role, or brand permissions without affecting other user settings. Use this when you need to update team member information or adjust access levels.