Skip to content

Privacy and analytics

We use necessary technical cookies and, only with your consent, analytics and marketing pixels to improve the website and measure campaigns.

Privacy policyCookie policy
Docs
GuidesDevelopers
English
EspañolEnglishFrançaisDeutschItalianoPortuguês

Start building

  • Your first API call
  • Limits, versions and headers

API

  • Brand API
    • Errors
    • Permissions and roles
    • Events and webhooks
    • Brand
    • Genome
    • Brand Kit
    • Library
    • Works
    • Calendar
    • Connections
    • Publishing
    • Inbox
    • Team
    • Account and team
    • Conversation
    • Memory
    • Questions
    • Media
    • Store
    • Plan
    • Orders
    • Activity
    • Workspace
    • Your account
    • Billing
    • Sync
    • Website and domains
    • Statistics
    • Mailing
    • Media
    • Events

MCP

  • MCP server

Connectors

  • Brand connectors
API/Brand API
Reference24 min read

Mailing

The brand's email marketing to its own customers: audience, campaigns, sender and reports. Sending is always confirmed by a person.

Русский
한국어
日本語
中文
हिन्दी
Open the app
On this page
  • mailing.forms.list · List forms
  • mailing.forms.get · Read a form
  • mailing.forms.create · Create a form
  • mailing.forms.update · Update a form
  • mailing.forms.trash · Delete a form
  • mailing.forms.restore · Restore a form
  • mailing.segments.list · List segments
  • mailing.segments.get · Read a segment
  • mailing.segments.count · Count who a rule names
  • mailing.segments.sample · See some contacts a rule names
  • mailing.segments.create · Create a segment
  • mailing.segments.update · Update a segment
  • mailing.segments.trash · Delete a segment
  • mailing.segments.restore · Restore a segment
  • mailing.reports.campaign · Read a campaign’s report
  • mailing.reports.audience · Read the audience report
  • mailing.campaigns.list · List campaigns
  • mailing.campaigns.get · Get a campaign
  • mailing.campaigns.create · Create a campaign
  • mailing.campaigns.update · Update a campaign
  • mailing.campaigns.duplicate · Duplicate a campaign
  • mailing.campaigns.reach · Count who a campaign would reach
  • mailing.campaigns.send · Send a campaign
  • mailing.campaigns.pause · Pause a campaign that is sending
  • mailing.campaigns.resume · Resume a paused campaign
  • mailing.campaigns.cancel · Cancel a campaign that is sending
  • mailing.campaigns.unschedule · Unschedule a campaign
  • mailing.campaigns.trash · Delete a campaign
  • mailing.campaigns.restore · Restore a campaign
  • mailing.templates.list · List templates
  • mailing.templates.get · Get a template
  • mailing.templates.create · Create a template
  • mailing.templates.update · Update a template
  • mailing.templates.duplicate · Duplicate a template
  • mailing.templates.trash · Delete a template
  • mailing.templates.restore · Restore a template
  • mailing.design.look · Read the look of the emails
  • mailing.design.preview · Preview an email
  • mailing.design.check_links · Check the links of an email
  • mailing.design.send_test · Send myself a test of an email
  • mailing.media.publish · Prepare an image for an email
  • mailing.sender.read · Read the sender
  • mailing.sender.save · Save the sender
  • mailing.sender.check · Check the sender’s domain
  • mailing.sender.dns_apply · Write the sender’s DNS records
  • mailing.exports.list · List exports
  • mailing.exports.create · Export the audience
  • mailing.exports.page · Read a page of an export
  • mailing.imports.list · List imports
  • mailing.imports.get · Get an import
  • mailing.imports.create · Start an import
  • mailing.imports.append · Add rows to an import
  • mailing.imports.check · Check an import
  • mailing.imports.apply · Apply an import
  • mailing.imports.cancel · Cancel an import
  • mailing.overview · Mailing overview
  • mailing.contacts.list · List contacts
  • mailing.contacts.get · Get a contact
  • mailing.contacts.create · Add a contact
  • mailing.contacts.update · Update a contact
  • mailing.contacts.unsubscribe · Unsubscribe contacts
  • mailing.contacts.erase · Erase contacts
  • mailing.fields.list · List fields
  • mailing.fields.create · Create a field
  • mailing.fields.update · Update a field
  • mailing.groups.list · List groups
  • mailing.groups.create · Create a group
  • mailing.groups.update · Update a group
  • mailing.groups.trash · Delete a group
  • mailing.groups.restore · Restore a group
  • mailing.groups.members.add · Add contacts to a group
  • mailing.groups.members.remove · Remove contacts from a group
  • mailing.topics.list · List topics
  • mailing.topics.create · Create a topic
  • mailing.topics.update · Update a topic
  • mailing.settings.read · Read Mailing settings
  • mailing.settings.update · Update Mailing settings

The exact input and output of each operation are in /api/v1/openapi.json with your token, or from an agent with nomad_describe.

mailing.forms.list · List forms

The brand’s signup forms, with how many signups each has taken. Read one with mailing.forms.get.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.forms.list
MCP toolmailing_forms_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.forms.get · Read a form

A form with its texts, the fields it asks for, the consent wording it records and the address of its page.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.forms.get
MCP toolmailing_forms_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.forms.create · Create a form

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.forms.create
MCP toolmailing_forms_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.forms.update · Update a form

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.forms.update
MCP toolmailing_forms_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.forms.trash · Delete a form

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.forms.trash
MCP toolmailing_forms_trash
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.forms.restore · Restore a form

Brings a deleted form back to the list, as it was.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.forms.restore
MCP toolmailing_forms_restore
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.list · List segments

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.segments.list
MCP toolmailing_segments_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.get · Read a segment

A segment with its definition and how many contacts it names now.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.segments.get
MCP toolmailing_segments_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.count · Count who a rule names

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.segments.count
MCP toolmailing_segments_count
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.sample · See some contacts a rule names

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.segments.sample
MCP toolmailing_segments_sample
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.create · Create a segment

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.segments.create
MCP toolmailing_segments_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.update · Update a segment

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.segments.update
MCP toolmailing_segments_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.segments.trash · Delete a segment

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.segments.trash
MCP toolmailing_segments_trash
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.segments.restore · Restore a segment

Brings a deleted segment back to the list, with its rule.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.segments.restore
MCP toolmailing_segments_restore
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.reports.campaign · Read a campaign’s report

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.reports.campaign
MCP toolmailing_reports_campaign
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.reports.audience · Read the audience report

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.reports.audience
MCP toolmailing_reports_audience
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.list · List campaigns

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.campaigns.list
MCP toolmailing_campaigns_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.get · Get a campaign

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.campaigns.get
MCP toolmailing_campaigns_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.create · Create a campaign

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.create
MCP toolmailing_campaigns_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.update · Update a campaign

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).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.update
MCP toolmailing_campaigns_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.duplicate · Duplicate a campaign

Creates a new draft with another campaign’s content, audience and topic, whether that one was sent or not.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.duplicate
MCP toolmailing_campaigns_duplicate
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.reach · Count who a campaign would reach

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.campaigns.reach
MCP toolmailing_campaigns_reach
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.send · Send a campaign

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.send
MCP toolmailing_campaigns_send
Scopemailing.write
Minimum roleAdmin
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.campaigns.pause · Pause a campaign that is sending

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).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.pause
MCP toolmailing_campaigns_pause
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.resume · Resume a paused campaign

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.resume
MCP toolmailing_campaigns_resume
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.cancel · Cancel a campaign that is sending

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.cancel
MCP toolmailing_campaigns_cancel
Scopemailing.write
Minimum roleAdmin
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.campaigns.unschedule · Unschedule a campaign

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).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.unschedule
MCP toolmailing_campaigns_unschedule
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.campaigns.trash · Delete a campaign

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).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.trash
MCP toolmailing_campaigns_trash
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.campaigns.restore · Restore a campaign

Brings a deleted campaign back to the list, as it was.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.campaigns.restore
MCP toolmailing_campaigns_restore
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.list · List templates

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.templates.list
MCP toolmailing_templates_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.get · Get a template

One template with its content: subject, preheader and design per language. Draw it with mailing.design.preview.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.templates.get
MCP toolmailing_templates_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.create · Create a template

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.templates.create
MCP toolmailing_templates_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.update · Update a template

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.templates.update
MCP toolmailing_templates_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.duplicate · Duplicate a template

Creates a new template with another one’s content and the name given.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.templates.duplicate
MCP toolmailing_templates_duplicate
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.templates.trash · Delete a template

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.templates.trash
MCP toolmailing_templates_trash
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.templates.restore · Restore a template

Brings a deleted template back to the list, as it was.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.templates.restore
MCP toolmailing_templates_restore
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.design.look · Read the look of the emails

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.design.look
MCP toolmailing_design_look
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.design.preview · Preview an email

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.design.preview
MCP toolmailing_design_preview
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.design.check_links · Check the links of an email

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.design.check_links
MCP toolmailing_design_check_links
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.design.send_test · Send myself a test of an email

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.design.send_test
MCP toolmailing_design_send_test
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.media.publish · Prepare an image for an email

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.media.publish
MCP toolmailing_media_publish
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.sender.read · Read the sender

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.sender.read
MCP toolmailing_sender_read
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.sender.save · Save the sender

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.sender.save
MCP toolmailing_sender_save
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.sender.check · Check the sender’s domain

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.sender.check
MCP toolmailing_sender_check
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.sender.dns_apply · Write the sender’s DNS records

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.sender.dns_apply
MCP toolmailing_sender_dns_apply
Scopemailing.write
Minimum roleAdmin
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.exports.list · List exports

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.exports.list
MCP toolmailing_exports_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.exports.create · Export the audience

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.exports.create
MCP toolmailing_exports_create
Scopemailing.write
Minimum roleAdmin
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.exports.page · Read a page of an export

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.exports.page
MCP toolmailing_exports_page
Scopemailing.read
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.list · List imports

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.imports.list
MCP toolmailing_imports_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.get · Get an import

One import with its state and its counts per verdict.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.imports.get
MCP toolmailing_imports_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.create · Start an import

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).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.imports.create
MCP toolmailing_imports_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.append · Add rows to an import

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.imports.append
MCP toolmailing_imports_append
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.check · Check an import

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.imports.check
MCP toolmailing_imports_check
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.imports.apply · Apply an import

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.imports.apply
MCP toolmailing_imports_apply
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.imports.cancel · Cancel an import

Cancels an import that was not applied yet and deletes its staged rows. The audience is untouched.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.imports.cancel
MCP toolmailing_imports_cancel
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.overview · Mailing overview

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.overview
MCP toolmailing_overview
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.contacts.list · List contacts

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.contacts.list
MCP toolmailing_contacts_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.contacts.get · Get a contact

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.contacts.get
MCP toolmailing_contacts_get
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.contacts.create · Add a contact

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.contacts.create
MCP toolmailing_contacts_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.contacts.update · Update a contact

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.contacts.update
MCP toolmailing_contacts_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.contacts.unsubscribe · Unsubscribe contacts

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.contacts.unsubscribe
MCP toolmailing_contacts_unsubscribe
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.contacts.erase · Erase contacts

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.contacts.erase
MCP toolmailing_contacts_erase
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.fields.list · List fields

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.fields.list
MCP toolmailing_fields_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.fields.create · Create a field

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.fields.create
MCP toolmailing_fields_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.fields.update · Update a field

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.fields.update
MCP toolmailing_fields_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.list · List groups

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.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.groups.list
MCP toolmailing_groups_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.create · Create a group

Creates an empty group. The name is unique among the brand’s groups (mailing_group_exists). Add contacts with mailing.groups.members.add.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.create
MCP toolmailing_groups_create
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.update · Update a group

Changes a group’s name or description. Its members do not change.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.update
MCP toolmailing_groups_update
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.trash · Delete a group

Deletes a group. Its contacts stay in the audience; only the list goes. mailing.groups.restore brings it back with its members.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.trash
MCP toolmailing_groups_trash
Scopemailing.write
Minimum roleMember
Human confirmationYes
DoorsScreens
StatusAvailable

mailing.groups.restore · Restore a group

Brings a deleted group back with its members. Refuses when another group took its name meanwhile (mailing_group_exists).

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.restore
MCP toolmailing_groups_restore
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.members.add · Add contacts to a group

Puts contacts of the brand into a group. Contacts already in it are skipped; returns how many were added.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.members.add
MCP toolmailing_groups_members_add
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.groups.members.remove · Remove contacts from a group

Takes contacts out of a group. They stay in the audience; returns how many were removed.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.groups.members.remove
MCP toolmailing_groups_members_remove
Scopemailing.write
Minimum roleMember
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.topics.list · List topics

The brand’s subscription topics (“News”, “Offers”): what each contact chooses to receive in its preference centre.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.topics.list
MCP toolmailing_topics_list
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.topics.create · Create a topic

Creates a subscription topic. The key never changes afterwards: consent records name the topic by it.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.topics.create
MCP toolmailing_topics_create
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.topics.update · Update a topic

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.topics.update
MCP toolmailing_topics_update
Scopemailing.write
Minimum roleAdmin
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.settings.read · Read Mailing settings

The brand’s Mailing settings: the legal footer of every campaign, double opt-in, tracking and the sending state.

FieldValue
KindRead
HTTP methodPOST /api/v1/mailing.settings.read
MCP toolmailing_settings_read
Scopemailing.read
Minimum roleViewer
Human confirmationNo
DoorsScreens
StatusAvailable

mailing.settings.update · Update Mailing settings

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.

FieldValue
KindWrite
HTTP methodPOST /api/v1/mailing.settings.update
MCP toolmailing_settings_update
Scopemailing.write
Minimum roleAdmin
Human confirmationYes
DoorsScreens
StatusAvailable
PreviousStatisticsNextMedia

In this section

  • Errors
  • Permissions and roles
  • Events and webhooks
  • Brand
  • Genome
  • Brand Kit
  • Library
  • Works
Can't find what you need? Write to usWrite to usGo to the app
© 2026 Nömad · Nömad documentationLinkedInInstagramThreadsFacebookTikTokYouTubeX
Go to nomad.oooBack to top

On this page

  • mailing.forms.list · List forms
  • mailing.forms.get · Read a form
  • mailing.forms.create · Create a form
  • mailing.forms.update · Update a form
  • mailing.forms.trash · Delete a form
  • mailing.forms.restore · Restore a form
  • mailing.segments.list · List segments
  • mailing.segments.get · Read a segment
  • mailing.segments.count · Count who a rule names
  • mailing.segments.sample · See some contacts a rule names
  • mailing.segments.create · Create a segment
  • mailing.segments.update · Update a segment
  • mailing.segments.trash · Delete a segment
  • mailing.segments.restore · Restore a segment
  • mailing.reports.campaign · Read a campaign’s report
  • mailing.reports.audience · Read the audience report
  • mailing.campaigns.list · List campaigns
  • mailing.campaigns.get · Get a campaign
  • mailing.campaigns.create · Create a campaign
  • mailing.campaigns.update · Update a campaign
  • mailing.campaigns.duplicate · Duplicate a campaign
  • mailing.campaigns.reach · Count who a campaign would reach
  • mailing.campaigns.send · Send a campaign
  • mailing.campaigns.pause · Pause a campaign that is sending
  • mailing.campaigns.resume · Resume a paused campaign
  • mailing.campaigns.cancel · Cancel a campaign that is sending
  • mailing.campaigns.unschedule · Unschedule a campaign
  • mailing.campaigns.trash · Delete a campaign
  • mailing.campaigns.restore · Restore a campaign
  • mailing.templates.list · List templates
  • mailing.templates.get · Get a template
  • mailing.templates.create · Create a template
  • mailing.templates.update · Update a template
  • mailing.templates.duplicate · Duplicate a template
  • mailing.templates.trash · Delete a template
  • mailing.templates.restore · Restore a template
  • mailing.design.look · Read the look of the emails
  • mailing.design.preview · Preview an email
  • mailing.design.check_links · Check the links of an email
  • mailing.design.send_test · Send myself a test of an email
  • mailing.media.publish · Prepare an image for an email
  • mailing.sender.read · Read the sender
  • mailing.sender.save · Save the sender
  • mailing.sender.check · Check the sender’s domain
  • mailing.sender.dns_apply · Write the sender’s DNS records
  • mailing.exports.list · List exports
  • mailing.exports.create · Export the audience
  • mailing.exports.page · Read a page of an export
  • mailing.imports.list · List imports
  • mailing.imports.get · Get an import
  • mailing.imports.create · Start an import
  • mailing.imports.append · Add rows to an import
  • mailing.imports.check · Check an import
  • mailing.imports.apply · Apply an import
  • mailing.imports.cancel · Cancel an import
  • mailing.overview · Mailing overview
  • mailing.contacts.list · List contacts
  • mailing.contacts.get · Get a contact
  • mailing.contacts.create · Add a contact
  • mailing.contacts.update · Update a contact
  • mailing.contacts.unsubscribe · Unsubscribe contacts
  • mailing.contacts.erase · Erase contacts
  • mailing.fields.list · List fields
  • mailing.fields.create · Create a field
  • mailing.fields.update · Update a field
  • mailing.groups.list · List groups
  • mailing.groups.create · Create a group
  • mailing.groups.update · Update a group
  • mailing.groups.trash · Delete a group
  • mailing.groups.restore · Restore a group
  • mailing.groups.members.add · Add contacts to a group
  • mailing.groups.members.remove · Remove contacts from a group
  • mailing.topics.list · List topics
  • mailing.topics.create · Create a topic
  • mailing.topics.update · Update a topic
  • mailing.settings.read · Read Mailing settings
  • mailing.settings.update · Update Mailing settings