delete_contact
Delete Contact
Permanently delete a contact from a brand. The contact is identified by ID or email address. This action is irreversible.
delete_contact
Permanently delete a contact from a brand. The contact is identified by ID or email address. This action is irreversible.
manage_sender
Create a new sender identity or delete an existing one for a brand. Senders are email addresses or domains used as the "from" address in campaigns. Set `action` to "create" or "delete".
create_or_update_list
Create a new list or update an existing one within a brand. Lists behave like tags - contacts can belong to multiple lists without duplication. To update, provide `listId`. To create, omit `listId`.
list_lists
Retrieve all lists (tag groups) within a brand. Returns list names and whether each is the system-generated "all contacts" list.
list_brands
List brands (subaccounts) in your BigMailer account. Returns brand details including name, default sender info, bounce settings, and contact limits. Use pagination parameters to iterate through large brand lists.
send_transactional_email
Send a transactional email through a pre-configured campaign. The campaign must first be set up in the BigMailer console with from address, subject, and body template. This also upserts the contact: if the email does not exist, a new contact is created; if it exists, the contact is updated.
list_senders
List sender identities configured for a brand. Returns sender domains/emails, verification status, DNS records, and sharing settings.
get_contact
Retrieve a contact by ID or email address. Returns full contact details including field values, list memberships, bounce counts, complaint counts, and subscription status.
upsert_contact
Create or update a contact by email address. If the email does not exist, a new contact is created. If the email exists, the existing contact is updated. Supports email validation and custom field values.
list_contacts
List contacts within a brand. Optionally filter by a specific list. Returns contact emails, field values, list memberships, bounce/complaint counts, and subscription status.
get_brand
Retrieve details of a specific brand by its ID. Returns full brand configuration including sender defaults, bounce settings, and contact limits.
list_bulk_campaigns
List bulk (marketing) campaigns within a brand. Returns campaign details including subject, status, tracking settings, and delivery metrics such as sends, opens, clicks, bounces, and complaints.
create_bulk_campaign
Create a new bulk (marketing) campaign within a brand. Configure the campaign subject, content, target lists, sender info, tracking, and scheduling. Set `ready` to true to activate sending.
list_fields
List all custom fields defined for a brand. Returns field names, data types, merge tag names, and sample values used for test campaigns.
create_or_update_brand
Create a new brand or update an existing one. To update, provide the `brandId`. To create, omit `brandId` and provide at least a `name`. Brands are subaccounts with their own lists, contacts, campaigns, and senders.
create_field
Create a custom field for contacts within a brand. Fields store data on contacts and can be used as merge tags in campaigns and for segmentation. It is recommended to define fields with proper data types upfront for correct segmentation behavior.
Manage multi-brand email marketing and transactional email sending. Create and manage brands, contacts, lists, suppression lists, custom fields, and senders. Send transactional emails with merge tags and field values. Create and list bulk marketing campaigns with A/B testing support. Upsert contacts with email validation, manage contact subscriptions across lists, and track bounces and complaints. Receive webhook events for bounces, clicks, opens, unsubscribes, and spam complaints.
Common questions about connecting Bigmailer to AI agents with Metorial.