Mailing
The brand's email marketing to its own customers: audience, campaigns, sender and reports. Sending is always confirmed by a person.
Privacy and analytics
We use necessary technical cookies and, only with your consent, analytics and marketing pixels to improve the website and measure campaigns.
The brand's email marketing to its own customers: audience, campaigns, sender and reports. Sending is always confirmed by a person.
The exact input and output of each operation are in /api/v1/openapi.json with your token, or from an agent with nomad_describe.
The brand’s signup forms, with how many signups each has taken. Read one with mailing.forms.get.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.forms.list |
| MCP tool | mailing_forms_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
A form with its texts, the fields it asks for, the consent wording it records and the address of its page.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.forms.get |
| MCP tool | mailing_forms_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a signup form with a starting title and consent wording in the language the brand writes to its audience in. It is born open; change it with mailing.forms.update. Refusal: mailing_forms_limit.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.forms.create |
| MCP tool | mailing_forms_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a form’s texts, fields, consent wording, group or status; only what is sent changes. fields replaces the whole list. A new consent wording applies to signups from then on: earlier ones keep the wording they agreed to. Refusals: mailing_form_field_invalid:<key>, mailing_group_not_found.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.forms.update |
| MCP tool | mailing_forms_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Deletes a form: its page stops taking signups. Whoever came in through it stays in the audience, with their consent on record. mailing.forms.restore brings it back.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.forms.trash |
| MCP tool | mailing_forms_trash |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Brings a deleted form back to the list, as it was.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.forms.restore |
| MCP tool | mailing_forms_restore |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s segments: rules over its audience (“whoever opened the last campaign and lives in Madrid”). A segment holds no contact: it is resolved every time. Read one with mailing.segments.get.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.segments.list |
| MCP tool | mailing_segments_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
A segment with its definition and how many contacts it names now.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.segments.get |
| MCP tool | mailing_segments_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
How many contacts a definition names now, without storing it. A definition with an unknown field, operator or value is refused (mailing_segment_invalid:<path>:<issue>). Sends nothing.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.segments.count |
| MCP tool | mailing_segments_count |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Up to 50 of the contacts a definition names, newest first, to check a rule before trusting it. Personal data of the brand’s contacts.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.segments.sample |
| MCP tool | mailing_segments_sample |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a segment with its definition; without one it names everyone. Check a rule first with mailing.segments.count. Refusals: mailing_segment_invalid:<path>:<issue>, mailing_segments_limit.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.segments.create |
| MCP tool | mailing_segments_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a segment’s name, description or definition; only what is sent changes. A definition replaces the whole rule. Campaigns that use it reach whoever the new rule names when they are sent.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.segments.update |
| MCP tool | mailing_segments_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Deletes a segment. Its contacts stay in the audience: only the rule goes. A campaign that named it reaches nobody until it names another audience. mailing.segments.restore brings it back.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.segments.trash |
| MCP tool | mailing_segments_trash |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Brings a deleted segment back to the list, with its rule.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.segments.restore |
| MCP tool | mailing_segments_restore |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
What happened to a campaign: sent, delivered, opens, clicks, unsubscribes, bounces and complaints, its links with their clicks, why some emails did not go out, and opens by hour over its first 72 hours. Counts only: no person is named. Opens and clicks are estimates.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.reports.campaign |
| MCP tool | mailing_reports_campaign |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
How the audience stands and how it moved over a window of days (7 to 365, default 30): contacts by status, new contacts and unsubscribes per day, and the campaigns sent in it with their totals. Counts only: no person is named.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.reports.audience |
| MCP tool | mailing_reports_audience |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s campaigns, most recent first, with their state, subject and audience. Without their content; use mailing.campaigns.get for one. status narrows the list.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.campaigns.list |
| MCP tool | mailing_campaigns_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
One campaign with its content, how many people it would reach now (reach) and what a draft still lacks before it can be sent (gaps: subject, content, audience). Draw it with mailing.design.preview.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.campaigns.get |
| MCP tool | mailing_campaigns_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a draft campaign from one of the brand’s templates (templateId), from a starting point drawn with its identity (starterKey), or from a content of the caller’s. It goes to everyone subscribed until another audience is set. The content is cleaned before it is stored. Sends nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.create |
| MCP tool | mailing_campaigns_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a draft campaign’s name, content, audience or topic; only what is sent changes. A content replaces the whole content and is cleaned before it is stored. A campaign that is no longer a draft is refused (mailing_campaign_not_editable); a group or topic that is not the brand’s, too (mailing_group_not_found, mailing_topic_not_found).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.update |
| MCP tool | mailing_campaigns_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a new draft with another campaign’s content, audience and topic, whether that one was sent or not.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.duplicate |
| MCP tool | mailing_campaigns_duplicate |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
How many people an email with that audience and topic would reach now: subscribed, receiving the topic, in those groups and not suppressed. The same rule a send uses. Sends nothing.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.campaigns.reach |
| MCP tool | mailing_campaigns_reach |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Confirms a draft and starts sending it in batches. expectedRecipients is the number the person saw (reach.recipients): if the audience is another number now, nothing is sent and the answer is confirmed false with the current number, to confirm again. Refusals in detail: mailing_campaign_missing_<gap>, mailing_campaign_no_recipients, or mailing_send_<block> when the brand cannot send. With review true the brand is in test mode and its first campaign waits for the team.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.send |
| MCP tool | mailing_campaigns_send |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Stops a campaign that is sending (sending). Whoever already got it keeps it; everyone else waits until mailing.campaigns.resume. A batch already taken finishes. Any other state is refused (mailing_campaign_wrong_state).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.pause |
| MCP tool | mailing_campaigns_pause |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Continues a paused campaign from where it stopped; nobody gets it twice. Refused with mailing_send_<block> while the brand cannot send (for example mailing_send_sending_paused when the team paused the brand), and with mailing_campaign_wrong_state when it is not paused.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.resume |
| MCP tool | mailing_campaigns_resume |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Cancels for good a campaign that is sending or paused. Whoever has not got it yet will not; what was sent stays as the record. It cannot be undone. Any other state is refused (mailing_campaign_wrong_state): a scheduled one is unscheduled instead.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.cancel |
| MCP tool | mailing_campaigns_cancel |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Makes a scheduled campaign, or one waiting for the Nömad team (review), a draft again. Nothing was sent; it can be edited and confirmed again. Any other state is refused (mailing_campaign_wrong_state).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.unschedule |
| MCP tool | mailing_campaigns_unschedule |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Deletes a draft or cancelled campaign. It can be undone with mailing.campaigns.restore. A campaign that was sent, or is being sent, is the record of what the brand sent and is refused (mailing_campaign_not_removable).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.trash |
| MCP tool | mailing_campaigns_trash |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Brings a deleted campaign back to the list, as it was.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.campaigns.restore |
| MCP tool | mailing_campaigns_restore |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s email templates, most recent first, with their subject and the languages they are written in. Without their content; use mailing.templates.get for one.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.templates.list |
| MCP tool | mailing_templates_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
One template with its content: subject, preheader and design per language. Draw it with mailing.design.preview.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.templates.get |
| MCP tool | mailing_templates_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a template from a starting point (newsletter, launch, announcement, welcome, reactivation), drawn with the brand’s identity of that moment in the language it writes to its audience in, or from a content of the caller’s. The content is cleaned before it is stored. Sends nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.templates.create |
| MCP tool | mailing_templates_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a template’s name, description or content; only what is sent changes. A content replaces the whole content and is cleaned before it is stored.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.templates.update |
| MCP tool | mailing_templates_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a new template with another one’s content and the name given.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.templates.duplicate |
| MCP tool | mailing_templates_duplicate |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Deletes a template. It can be undone with mailing.templates.restore: it comes back as it was. Campaigns that started from it do not change.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.templates.trash |
| MCP tool | mailing_templates_trash |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Brings a deleted template back to the list, as it was.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.templates.restore |
| MCP tool | mailing_templates_restore |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The identity the brand’s emails carry, read from where the brand keeps it: the theme (button and link colour, font stack), the logo, its networks, its website and the legal footer. missing says what the identity still lacks (logo, colors, legal, website). A new design starts from theme; the frame is not editable per email.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.design.look |
| MCP tool | mailing_design_look |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
A design as a contact would open it, inside the brand’s frame, as HTML and as text, with what the lint says about it (contrast, images without alt text, empty links, size against Gmail’s clipping limit). The design is cleaned before it is drawn. Sends nothing and stores nothing.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.design.preview |
| MCP tool | mailing_design_preview |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Asks for every https link of a content, in all its languages (up to 30), and answers the ones that do not respond (broken_link, with the address and why: 404, dns, timeout). A page behind a login or a bot wall counts as alive. Results are cached for 15 minutes. Sends nothing and stores nothing.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.design.check_links |
| MCP tool | mailing_design_check_links |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Sends the email, as it would go out, to the caller’s own address and to no other, with the subject marked as a test and the caller’s name in the variables. It goes through the brand’s sender and the door every send uses. sent false comes with reason: one of the door’s blocks (sender_missing, provider_not_connected…), test_mode_recipient, suppressed, no_email, no_content, rate_limited (20 an hour) or send_failed. Stores nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.design.send_test |
| MCP tool | mailing_design_send_test |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Makes, from an image of the brand’s Library, the copy an email can carry: JPEG, PNG or GIF (never WebP or SVG), at most 1600 px wide and 3 MB, metadata stripped, at a public address that never changes. The same image is always the same copy, and it outlives the Library file: delivered emails keep loading it. Refusals in detail: mailing_image_not_found, mailing_image_not_an_image, mailing_image_too_large, mailing_image_unreadable, mailing_media_limit.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.media.publish |
| MCP tool | mailing_media_publish |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Who the brand’s campaigns come from: name, address, reply-to, its domain (its own or the shared one) and the state of the DNS records that let it send. For its own domain it lists each record to publish and what the last check saw.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.sender.read |
| MCP tool | mailing_sender_read |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates or changes the brand’s sender. With its own domain it stays pending until its DNS records are published (mailing.sender.check); a mailbox provider’s domain (gmail.com, outlook.com…) cannot be a sender, and such a brand uses the shared domain with its address as the reply-to. Changing the domain asks for the check again. Sends nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.sender.save |
| MCP tool | mailing_sender_save |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Looks in public DNS for the records of the brand’s domain and says what it sees for each. With all of them the sender is verified; a lookup that fails concludes nothing and takes nothing away. DNS changes can take up to 48 hours to be seen.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.sender.check |
| MCP tool | mailing_sender_check |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
When the domain’s DNS is kept in Nömad, writes the sender’s missing records and checks them. It touches no other record, an existing DMARC policy is kept, and the change can be undone from the domain’s own screen.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.sender.dns_apply |
| MCP tool | mailing_sender_dns_apply |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
The record of who took the brand’s audience out: the latest exports with their author, their filter and how many rows they held. Returns no contact.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.exports.list |
| MCP tool | mailing_exports_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Opens an export of the brand’s contacts (all of them, or those of one status or one group) or of its suppressions. It needs a recent sign-in, it is recorded with its author and whoever decides in the brand is told. The rows are then read in pages (mailing.exports.page), for thirty minutes and only by whoever opened it. At most ten per brand and hour.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.exports.create |
| MCP tool | mailing_exports_create |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
One page (up to 1,000 rows) of an open export, with everything about each contact: fields, groups, topics, status, source and their first consent. Only whoever opened the export reads it, and only inside its window. next is the after of the following page; null means it was the last one.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.exports.page |
| MCP tool | mailing_exports_page |
| Scope | mailing.read |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s latest imports with their state, their declaration of origin and their counts per verdict. Returns no rows of the files: staged rows are deleted when an import is applied or cancelled.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.imports.list |
| MCP tool | mailing_imports_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
One import with its state and its counts per verdict.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.imports.get |
| MCP tool | mailing_imports_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Opens an import of contacts or of suppressions (the unsubscribes, bounces and complaints of another tool). A contacts import must declare where the list comes from and why the brand may write to it; a bought, rented or scraped list is never accepted. It does not touch the audience: rows are staged (append), checked (check) and only then applied (apply).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.imports.create |
| MCP tool | mailing_imports_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Stages one chunk of rows (up to 500) of an open import; call it as many times as the file needs, up to 100,000 rows. Nothing enters the audience yet. Returns how many rows were staged and how many custom values were left out for not fitting their field.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.imports.append |
| MCP tool | mailing_imports_append |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Gives every staged row its verdict: new, already a contact, repeated, not an address, suppressed, a technical mailbox or a throwaway domain. A contacts import with too many bad addresses is quarantined and cannot be applied. Can be run again while rows are still being added.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.imports.check |
| MCP tool | mailing_imports_check |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Applies a checked import in one step: new rows become subscribed contacts with their consent record (the import’s declaration), existing ones are updated only if the import says so, and suppressions are stored. Nobody who unsubscribed, complained or bounced is brought back. The staged rows are deleted. Sends nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.imports.apply |
| MCP tool | mailing_imports_apply |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Cancels an import that was not applied yet and deletes its staged rows. The audience is untouched.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.imports.cancel |
| MCP tool | mailing_imports_cancel |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Where the brand’s Mailing stands: whether it can send or is still in test mode, what is missing before it can send, and the size of its audience by status. Returns no contacts; use the contact operations for those.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.overview |
| MCP tool | mailing_overview |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
One page of the brand’s audience, newest first, with the total of the filter and the count per status. Filter by text (email or name), status, group or topic. Returns personal data of the brand’s contacts: ask only for what the task needs.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.contacts.list |
| MCP tool | mailing_contacts_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
One contact with its custom fields, its groups and its consent history (the latest 50 records): what it agreed to, when, on which basis and through which source.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.contacts.get |
| MCP tool | mailing_contacts_get |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Adds one subscribed contact to the audience. The legal basis must be declared: the person’s express consent or an existing customer relationship. Refuses an address that already exists (mailing_contact_exists) or that unsubscribed, complained, bounced or was erased (mailing_contact_suppressed): only the person’s own new opt-in brings them back. Sends nothing.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.contacts.create |
| MCP tool | mailing_contacts_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a contact’s data, custom fields, topics or groups. Only what is sent changes. It never changes the status: taking someone out is mailing.contacts.unsubscribe, and nobody but the person subscribes them again.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.contacts.update |
| MCP tool | mailing_contacts_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Takes contacts out of everything the brand sends and leaves their address suppressed. The brand cannot undo it: only the person subscribes again. Contacts already out are skipped; returns how many changed.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.contacts.unsubscribe |
| MCP tool | mailing_contacts_unsubscribe |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Erases contacts for good, at the person’s request: their data, fields and groups go; their consent history loses every personal datum and their address stays suppressed without being kept. Cannot be undone, and an agent can never do it.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.contacts.erase |
| MCP tool | mailing_contacts_erase |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
The custom fields the brand defined for its contacts, in order: key, label, type and options. With includeArchived, archived ones too. A contact’s values are keyed by key.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.fields.list |
| MCP tool | mailing_fields_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a custom field for the brand’s contacts. The key never changes afterwards: segments and merge tags name it. The type cannot change either; create another field instead.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.fields.create |
| MCP tool | mailing_fields_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a field’s label, options, order or merge-tag offer, and archives or brings it back. A field is never deleted: archived, it stops being offered and its values are kept.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.fields.update |
| MCP tool | mailing_fields_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s groups (hand-made lists) with how many contacts each holds. Being in a group is not consent: a campaign still reaches only subscribed contacts.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.groups.list |
| MCP tool | mailing_groups_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates an empty group. The name is unique among the brand’s groups (mailing_group_exists). Add contacts with mailing.groups.members.add.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.create |
| MCP tool | mailing_groups_create |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a group’s name or description. Its members do not change.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.update |
| MCP tool | mailing_groups_update |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Deletes a group. Its contacts stay in the audience; only the list goes. mailing.groups.restore brings it back with its members.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.trash |
| MCP tool | mailing_groups_trash |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |
Brings a deleted group back with its members. Refuses when another group took its name meanwhile (mailing_group_exists).
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.restore |
| MCP tool | mailing_groups_restore |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Puts contacts of the brand into a group. Contacts already in it are skipped; returns how many were added.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.members.add |
| MCP tool | mailing_groups_members_add |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Takes contacts out of a group. They stay in the audience; returns how many were removed.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.groups.members.remove |
| MCP tool | mailing_groups_members_remove |
| Scope | mailing.write |
| Minimum role | Member |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s subscription topics (“News”, “Offers”): what each contact chooses to receive in its preference centre.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.topics.list |
| MCP tool | mailing_topics_list |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Creates a subscription topic. The key never changes afterwards: consent records name the topic by it.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.topics.create |
| MCP tool | mailing_topics_create |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes a topic’s name, description, order or default flag, and archives or brings it back. A topic is never deleted: its consent history names it.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.topics.update |
| MCP tool | mailing_topics_update |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
The brand’s Mailing settings: the legal footer of every campaign, double opt-in, tracking and the sending state.
| Field | Value |
|---|---|
| Kind | Read |
| HTTP method | POST /api/v1/mailing.settings.read |
| MCP tool | mailing_settings_read |
| Scope | mailing.read |
| Minimum role | Viewer |
| Human confirmation | No |
| Doors | Screens |
| Status | Available |
Changes the legal footer (legal name and postal address, both required before sending), the default language, double opt-in and tracking. It never changes the sending state: that moves with the sender’s verification and the team’s review.
| Field | Value |
|---|---|
| Kind | Write |
| HTTP method | POST /api/v1/mailing.settings.update |
| MCP tool | mailing_settings_update |
| Scope | mailing.write |
| Minimum role | Admin |
| Human confirmation | Yes |
| Doors | Screens |
| Status | Available |