Reference

Get User

Retrieve detailed information about the authenticated user account, including profile data and account settings associated with your API credentials.

Get Campaign Bounces

Retrieve a list of subscribers whose emails bounced when you sent a campaign, helping you identify delivery issues and maintain a clean email list. This lets you understand which addresses are no longer valid so you can take corrective action.

Get Campaign Clicks

Retrieve detailed click data from a sent campaign to analyze how recipients engaged with your email links and content. This helps you understand which messages resonated most with your audience.

Get Campaign Opens

Retrieve detailed open metrics for a sent campaign, including who opened it and how many times they opened it, helping you understand audience engagement. Use this to analyze which campaigns resonate most with your subscribers.

Get Campaign Unsubscribes

Retrieve a list of subscribers who unsubscribed from a specific email campaign, helping you understand why people are leaving your mailing list. This is useful for analyzing campaign performance and identifying content or messaging issues.

Add Mailcoach Campaign

Creates a new email campaign in Mailcoach that you can send to your subscriber lists or specific segments right away or schedule for later.

Get All Campaigns

Retrieve a complete list of all your email campaigns with pagination and sorting options. Use this to view, organize, and analyze your marketing campaigns at a glance.

Delete Campaign

Permanently removes a campaign from your email marketing account using its unique identifier. Use this when you need to clean up failed campaigns, remove duplicates, or delete campaigns that are no longer needed.

Get All Sent Items

Retrieve a complete list of all emails and messages you've sent through Mailcoach, allowing you to review delivery history and access past communications. Use this to track what you've sent, verify delivery status, and maintain records of your outgoing correspondence.

Get Specific Campaign

Retrieve detailed information about a specific email campaign including its status, performance metrics, and configuration settings. Use this to access comprehensive campaign data for analysis, optimization, or status checking.

Update Campaign

Modify an existing email campaign's details including name, schedule, content, and other attributes to keep your campaigns current and relevant.

Start Subscriber Import

Activates a prepared subscriber import to process CSV data and add or update contacts in your email list. Use this after uploading and reviewing your subscriber data to begin the import process.

Append to Subscriber Import

Add more subscriber data to an existing import batch in Mailcoach, allowing you to gradually build your email list without starting over. This is useful when you're collecting contacts from multiple sources or over time and want to add them to the same import session.

Create Subscriber Import

Prepare a bulk subscriber import from CSV data into your Mailcoach email list, enabling you to add multiple contacts at once without manual entry. The import is created in draft status so you can review it before activating.

Delete Subscriber Import

Permanently removes a subscriber import from your Mailcoach account so you can clean up failed or duplicate imports and free up resources.

Get All Subscriber Imports

Retrieve a complete list of all subscriber import jobs with pagination, allowing you to review import history and status across your email campaigns.

Get Subscriber Import

Retrieve detailed information about a specific subscriber import job, including its current status and progress. This helps you monitor and verify that your email list uploads are processing correctly.

Update Subscriber Import

Modify the settings and configuration of a draft subscriber import before it's executed, allowing you to correct or refine your subscriber data upload.

Add Email List

Create a new email list to organize and segment your subscribers for targeted campaigns. This helps you build separate mailing lists for different audience groups before sending communications.

Delete Email List

Permanently removes an email list from your Mailcoach account by its unique identifier. Use this when you no longer need a specific list or want to clean up inactive campaigns.

Get Email Lists

Retrieve all your email lists from Mailcoach so you can view, manage, and organize your subscriber segments. This helps you understand your audience structure and find specific lists for campaigns or analysis.

Get Specific Email List

Retrieves detailed information about a specific email list in Mailcoach, including subscriber count, email settings, and configuration details. Use this when you need to review or verify a list's current setup before sending campaigns or making changes.

Update Email List

Modify an existing email list's settings and configuration, such as name, description, or other list properties. Use this to keep your subscriber lists organized and up-to-date as your business needs change.

Create Segment for Email List

Create targeted subscriber groups within your email list based on specific criteria like tags, allowing you to send personalized campaigns to the right audience segments.

Delete Segment from Email List

Permanently remove a segment from your email list when you no longer need to target that specific subscriber group.

Get Segment

Retrieve detailed information about a specific email segment including its name, description, and subscriber count to verify segment configuration or audit your email list organization.

List Segments

Retrieve all audience segments for a specific email list, allowing you to see which subscriber groups are available based on their tags and characteristics.

Update Segment

Modify an existing email segment's criteria, name, or tag rules to keep your subscriber lists organized and targeted. Use this when your audience definitions change or you need to refine who receives specific campaigns.

List Subscribers

Retrieve all subscribers from your email list with optional filtering by email, search terms, or subscription status. Use this to access your complete subscriber data for analysis, outreach, or list management purposes.

Subscribe To Email List

Add or update subscribers on your email list and manage their information in one operation. This lets you grow your audience while keeping existing subscriber data current.

Update Subscriber

Modify subscriber information such as email, name, tags, or custom attributes in your email list without needing to recreate the contact.

Confirm Subscriber

Activate a subscriber's email list membership after they verify their email address through a confirmation link. This completes the double opt-in process and ensures only engaged subscribers receive your messages.

Delete Subscriber

Permanently remove a subscriber and all their associated data from your Mailcoach mailing list, allowing that email address to be re-subscribed later if needed.

Get Specific Subscriber

Retrieve detailed information about a specific subscriber in your mailing list using their unique identifier, allowing you to access their profile data and subscription status.

Resend Subscriber Confirmation

Resend a confirmation email to a subscriber who hasn't yet verified their email address, helping you complete their signup process.

Unsubscribe Subscriber

Remove a subscriber from receiving emails while keeping their record intact, allowing them to be resubscribed later if they change their mind.

Add suppression

Prevent email delivery to addresses that have bounced, been flagged as spam, or should be manually blocked from your mailing list. This helps maintain your sender reputation and ensures messages only go to engaged recipients.

Delete Suppression

Remove a suppressed email address or contact from your Mailcoach suppression list, allowing you to re-engage with that recipient in future campaigns.

Get All Suppressions

Retrieve all email addresses that are blocked from receiving messages in Mailcoach, including those flagged for bounces, spam complaints, or manual suppression. This helps you maintain list hygiene and understand who cannot be contacted.

Get Specific Suppression

Retrieve details about a specific suppressed email address or contact to understand why they were suppressed and manage your email list quality.

Add Tags to Subscriber

Organize and categorize your email subscribers by adding tags that help you segment your audience for targeted campaigns and personalized communications.

Add Tag to Email List

Organize and categorize subscribers within your email list by assigning tags to help segment and manage your audience more effectively.

Delete Tag from Email List

Remove a specific tag from your email list to clean up outdated categories or reorganize your subscriber segments. This helps maintain an organized tagging system as your list evolves.

Get All Tags

Retrieve all tags associated with a specific email list to organize and identify subscriber segments. This helps you understand how your contacts are categorized and segmented for targeted campaigns.

Get Specific Tag

Retrieve detailed information about a specific tag in your email list, including its properties and configuration. This helps you verify tag settings and understand how your contacts are organized before managing your campaigns.

Remove Tags from Subscriber

Remove specific tags from a subscriber to update their segmentation and communication preferences. This helps you keep your audience organization current as subscriber interests and statuses change.

Update Tag

Modify the name or visibility settings of an existing email tag to keep your subscriber segments organized and up-to-date.

Delete Template

Permanently remove an email template from your Mailcoach account to clean up unused designs or replace outdated messaging. Use this when you no longer need a template and want to maintain an organized template library.

Get All Templates

Retrieve all your email templates with filtering and sorting options to quickly find and manage your email designs. This helps you locate specific templates or get an overview of all your email assets.

Get Specific Template

Retrieves the complete details of a specific email template including its HTML content, name, and metadata. Use this when you need to review, audit, or prepare template content for sending or modification.

Update Template

Modify an existing email template's name, content, or HTML structure to keep your email designs current with your branding and messaging needs.

Add Transactional Email Template

Create reusable HTML email templates in Mailcoach that can be used for sending transactional emails like order confirmations, password resets, or notifications. Once created, these templates receive a unique identifier for easy reference and updates.

Delete Transactional Mail

Permanently removes a logged transactional email record from your system, allowing you to clean up old or unwanted email delivery logs. This helps maintain a clean history of your email communications.

Get All Transactional Email Templates

Retrieves a complete list of all transactional email templates in your Mailcoach account, allowing you to view and manage your automated email designs. This helps you keep track of your email templates and identify which ones are in use across your communication systems.

Get Transactional Mail

Retrieve the complete details of a specific transactional email including its subject, content, recipients, and configuration settings using its unique identifier.

List Transactional Mails

Retrieve a paginated list of all transactional emails that have been sent from your account, helping you track and audit automated customer communications.