Manage Mailtrap marketing contacts and campaign audiences
Manage Mailtrap's marketing contacts API: lists, segments, custom fields, bulk import, and custom events for campaign audiences.
Maintainer of this project? Claim this page to edit the listing.
13.6.1Add to Favorites
Why it matters
Automate the creation, update, and synchronization of marketing contacts in Mailtrap, including lists, segments, custom fields, and bulk imports to power email campaigns and CRM integrations.
Outcomes
What it gets done
Create and update individual contacts with custom fields and list assignments via API
Bulk import up to 50,000 contacts per async job with CSV or JSON payloads
Sync contacts bidirectionally with CRMs, CDPs, or data warehouses using API or no-code tools
Fire custom events on contacts to trigger marketing automations and segment audiences
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/ag-mailtrap-managing-contacts | bash Overview
Managing Mailtrap contacts
A guide to Mailtrap's Contacts API for managing lists, segments, custom fields, bulk imports, and custom events for campaign audiences. Use when managing Mailtrap marketing contacts, syncing with a CRM, or building segments - not for blocking sends, which is Suppressions.
What it does
This skill covers Mailtrap's Contacts API, the marketing database behind campaign audiences: lists, segments, custom fields, and bulk imports, plus custom events for triggering automations. It draws a hard line the skill itself emphasizes: contacts and their list/segment/consent attributes decide who is eligible for a marketing campaign, while Suppressions - hard bounces, spam complaints, unsubscribes - live on the sending side and block delivery on send streams entirely; the two systems are separate and must not be conflated.
When to use - and when NOT to
Use it for programmatic contact management (create, update, bulk import), syncing contacts with a CRM or data warehouse, list cleanup via CSV import, updating custom fields or firing custom events for automations, or building segments and custom fields for audience targeting. Before generating any request body, the skill points to checking Mailtrap's Contacts OpenAPI spec directly, since field names and required parameters can change. Blocking a recipient from receiving sends is explicitly out of scope here - that's the Suppressions system covered by the related mailtrap-sending-emails skill.
Inputs and outputs
All endpoints require Authorization: Bearer $MAILTRAP_API_TOKEN and an $MAILTRAP_ACCOUNT_ID resolved via GET /api/accounts. Core operations: contact CRUD at /accounts/{id}/contacts, bulk import at /contacts/imports (an async job, polled via GET .../imports/{import_id}, capped at 50,000 contacts per request), contact lists and custom fields at their own sub-paths, custom events posted as {name, params} to /contacts/{contact_identifier}/events, and contact export. The typical rate limit is 200 requests per 60 seconds per account, which is why bulk import is recommended over one-by-one creates for large loads. A single contact create takes an email, a fields object (e.g. first_name, company), and list_ids; bulk import takes an array of similarly-shaped contact objects.
curl -X POST "https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/imports" \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-d '{"contacts": [{"email": "user1@example.com", "fields": {"first_name": "John"}}]}'
Integrations
Sync can run through the Contacts API directly (real-time or scheduled from your own code) or through no-code tools like Zapier, Make, or n8n. Lists are explicitly-defined contact groups, segments are dynamic groups, and custom events feed Mailtrap's automations product; contacts maintained here are the audience source for the separate Campaigns product covering authoring and scheduling.
Who it's for
Developers integrating Mailtrap's marketing contact database with a CRM, data warehouse, or CSV import pipeline, who need to manage lists, segments, and custom fields at scale via bulk import rather than hitting rate limits with individual create calls, and who need to keep marketing eligibility clearly separate from sending-side suppression blocks.
Source README
Managing Mailtrap contacts
Overview
Before generating API request bodies: check the Contacts OpenAPI spec for current field names, required parameters, and nested structures.
Contacts are the marketing database: lists, segments, custom fields, and imports for campaign audiences and related workflows. The Contacts API automates create/update and can feed CRM or CDP sync (your code, or tools like Zapier, Make, n8n - see Import contacts).
Suppressions (hard bounces, spam complaints, unsubscribes on the sending side) live in the sending product and block delivery for those addresses on your streams. That is applied separately from marketing filters (segments, list membership, consent flags) that decide who is eligible for campaigns. For sending-side blocks, see Suppressions and mailtrap-sending-emails.
Related skills: mailtrap-sending-emails (live send paths).
When to use
- Programmatic contact management (create, update, bulk import)
- Sync with CRMs or data warehouses
- Contact list cleanup and CSV import
- Updating contacts with custom fields or firing custom events for automations
- Segments and custom fields for audience building
Authorization
All endpoints below need Authorization: Bearer $MAILTRAP_API_TOKEN and an $MAILTRAP_ACCOUNT_ID in the path. Resolve $MAILTRAP_ACCOUNT_ID from GET https://mailtrap.io/api/accounts, and store tokens in environment variables or a secrets manager.
Endpoints (replace placeholders)
| Action | Method | URL | Reference |
|---|---|---|---|
| Create / get / update / delete contact | various | https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts |
Contacts |
| Bulk import (async job) | POST |
https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/imports |
Bulk import |
| Contact lists | various | https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/lists |
Contact lists |
| Custom fields | various | https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/fields |
Contact fields |
| Custom events | POST |
https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/{contact_identifier}/events |
Contact events |
| Export contacts | various | https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/exports |
Export contacts |
- Rate limit (typical): 200 requests per 60 seconds per account - prefer bulk import for large loads.
- Bulk import limit: up to 50,000 contacts per import request (async job); poll import status with
GET .../contacts/imports/{import_id}. See Bulk import.
Examples (curl)
Single contact create (with custom fields)
curl -X POST "https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts" \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"contact": {
"email": "john.smith@example.com",
"fields": {"first_name": "John", "last_name": "Smith", "company": "Example Inc"},
"list_ids": [1, 2, 3]
}
}'
Bulk import (array of contacts)
curl -X POST "https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/imports" \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"contacts": [
{"email": "user1@example.com", "fields": {"first_name": "John"}, "list_ids_included": [1, 2]},
{"email": "user2@example.com", "fields": {"first_name": "Jane"}, "list_ids_included": [1]}
]
}'
Custom event (event name + payload)
curl -X POST "https://mailtrap.io/api/accounts/$MAILTRAP_ACCOUNT_ID/contacts/{contact_identifier}/events" \
-H "Authorization: Bearer $MAILTRAP_API_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"name": "UserLogin", "params": {"user_id": 101, "is_active": true}}'
Concepts
- Lists - explicitly defined list of contacts.
- Segments - dynamic groups; see Segments.
- Custom fields - properties like first and last name or membership level; see Custom fields.
- Custom events -
POST .../eventswith an eventnameandparamsobject for automations.
CRM and sync
- API: suitable for real-time or scheduled sync from your CRM or database.
- No-code: Zapier, Make.com, n8n per Import contacts - third-party tools.
Campaigns use case
Contacts power marketing campaigns: you maintain clean lists, consent, and attributes here; campaign authoring and scheduling are product features documented in Campaigns.
Common mistakes
| Mistake | Fix |
|---|---|
| Hitting rate limits with one-by-one creates | Use /contacts/imports for bulk loads (respect 50k per request) and backoff |
| Treating marketing contacts as sending suppressions | Use Suppressions for blocked recipients on send streams |
Limitations
- Contact API shapes can change; check Mailtrap's current OpenAPI spec before generating request bodies.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.