{"info":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","description":"

Welcome to the magnews REST API Postman collection!

Use the magnews API to integrate your platform with marketing automation workflows, contact management, and data-driven campaigns.

Getting Started

Follow our quick setup guide to quickly configure your Postman environment and start testing the requests included in this collection.

Environment setup

In the Postman collection variables, set the following values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`mn-baseurl`	REST API base URL, e.g. `https://ws-mn1.mag-news.it/ws/rest/api`
`mn-accesstoken`	Your access token
`mn-refreshtoken`	Your refresh token (optional). Recommended if you're using the interactive flow with short-lived access tokens.

You're ready!

Once your environment and authentication are set up, you can start testing the requests in this collection.

Explore the available folders to interact with contacts, communications, transactional messages, audiences, and other resources.

Support

Need help? Contact our support team

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Support","slug":"support"}],"owner":"44530038","collectionId":"c41301cc-4697-4aad-a300-3dff8accc11f","publishedId":"2sB2j4fWsn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"E5405C"},"publishDate":"2025-05-06T10:17:06.000Z"},"item":[{"name":"Token Management","item":[{"name":"Authorization code flow","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"731d7b58-0098-427a-95f1-651bfd583c1e"}}],"id":"90b713b9-1805-4f63-9366-105feba5ace0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"authRequestParams","value":""},{"key":"accessTokenUrl","value":""},{"key":"authUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"/v19","description":"

This request is part of the OAuth 2.0 authorization code flow (interactive). It allows you to:

Authorize a user by redirecting them to the magnews login page.
\n
Obtain an access token and refresh token upon successful login and consent.
\n

Set up Postman collection variables

\n
⚠️ Before using this request, you must setup additional environment variables
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Description
`mn-clientid`	Application ID from the digital certificate
`mn-clientsecret`	App secret from the certificate. If not available, you can reset it
`mn-account`	Your customer login (same used for manual login)
`mn-authserver`	This variable is already set to a default value. It defines the base URL of the authorization server and is used in: - The authorization dialog endpoint: https://be-mn1.mag-news.it/be/oauth/dialog - The token endpoint: https://be-mn1.mag-news.it/be/oauth/token

Always set the OAuth scope parameter to full, which grants access to all available API operations.

Generate access token and refresh token

Click on Get New Access Token in the Authorization tab and insert your user's credentials.

\n $\"magnews%20OAuth%202.0%20login\"$ \n\n

The Postman Authorization tab handles the flow by redirecting to the login URL and exchanging the authorization code for tokens.
Once completed, Postman can automatically store the access and refresh tokens and you can copy them from the Manage Tokens window.

Set collection variables mn-accesstoken e mn-refreshtoken with obtained tokens in order to reuse them in subsequent requests.

You are now ready to use the authenticated endpoints in this collection.

\n","urlObject":{"path":["v19"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"13708b27-2d0c-4de7-a88f-30474beec030","name":"Authorization code flow","originalRequest":{"method":"GET","header":[],"url":"https://ws-mn1.mag-news.it/ws/rest/api/v19"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"text/plain"},{"key":"Date","value":"Wed, 30 Apr 2025 19:57:33 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"v19"}],"_postman_id":"90b713b9-1805-4f63-9366-105feba5ace0"},{"name":"Refresh token","event":[{"listen":"test","script":{"id":"6ad39f5a-6af2-4e27-a10a-8cd7731be5b3","exec":["// Parse the JSON response body","let response = pm.response.json();","","// Check if access_token exists and save it as a collection variable","if (response.access_token) {"," pm.collectionVariables.set(\"mn-accesstoken\", response.access_token);"," console.log(\"Access token saved in collection variable: mn-accesstoken\");","} else {"," console.warn(\"Access token not found in response\");","}","","// Check if refresh_token exists and save it as a collection variable","if (response.refresh_token) {"," pm.collectionVariables.set(\"mn-refreshtoken\", response.refresh_token);"," console.log(\"Refresh token saved in collection variable: mn-refreshtoken\");","} else {"," console.warn(\"Refresh token not found in response\");","}",""],"type":"text/javascript","packages":{}}}],"id":"514a7cb0-57a6-4091-9a35-baed77b0b489","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"","description":"

The client ID found in the magnews digital certificate

\n","type":"text"},{"key":"client_secret","value":"","description":"

The client secret found in the magnews digital certificate

\n","type":"text"},{"key":"refresh_token","value":"","description":"

The refresh token obtained from the previous access token request

\n","type":"text"},{"key":"grant_type","value":"refresh_token","description":"

Must be set to refresh_token

\n","type":"text"}]},"url":"/be/oauth/token","description":"

This call is part of the OAuth 2.0 token refresh process. It allows you to:

Renew the access to protected APIs without re-authenticating the user.
\n
Receive a new access token and refresh token.
\n

The post request scripts, will automatically update collection variables mn-accesstokenand mn-refreshtoken.

The new access token will have the same expiration time as the original one, typically 4 hours (14399 seconds). After this period, you will need to refresh the token again to continue making authenticated API requests.

Magnews APIs use OAuth 2.0 for authentication.

\n","_postman_id":"755ea0da-8fb4-4f03-9a6f-d7ce7d56e42e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Transactional","item":[{"name":"Get simple message status","id":"4096bbb4-48b1-43bc-b7e9-f514871d19d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/simplemessages/message/:idmessage","description":"

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`address`	String	Email or SMS recipient.
`actualStatus`	String	Status of the transactional message. Possible values: `internalError`, `hardBounce`, `waiting`, `sent`, `notSent`, `softBounce`.
`sentDate`	Date	Delivery date.
`opened`	Boolean	`true` if the message was opened.
`lastOpenedTs`	Date	Timestamp of the last open event.
`clicked`	Boolean	`true` if the message was clicked.
`lastClickedTs`	Date	Timestamp of the last click event.
`idbouncecategory`	Integer	The ID of the bounce category.
`complainted`	Boolean	`true` if the message resulted in a complaint.
`notSentCause`	String	Detailed reason if `actualStatus` is `notSent`. Possible values: `unknown`, `blacklisted_recipient`, `cancelled`, `unsubscribed`, `forbidden_from`, `forbidden_replyto`, `maxsize_exceeded`, `phonerecipient_notallowed`, `empty_recipient`, `forbidden_smsfrom`, `forbidden_smsnumericfrom`, `no_credit`.

id of a transactional message

\n","type":"text/plain"},"type":"string","value":"27335","key":"idmessage"}]}},"response":[{"id":"c3cb7d3b-5737-4034-9215-c18ec95bf2b5","name":"Get simple message status","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/simplemessages/message/:idmessage","host":[""],"path":["v19","simplemessages","message",":idmessage"],"variable":[{"key":"idmessage","value":"27335","description":"id of a transactional message","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Permissions-Policy","value":"camera=(), geolocation=(), accelerometer=(), gyroscope=(), magnetometer=(), microphone=(), autoplay=(), usb=(), payment=(), fullscreen=()"},{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapg:7"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Tue, 17 Mar 2026 11:27:19 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"qapg_route_https;qapg_action_https;qapg_director_https;qapg_tomcat_mn03_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"messageId\": \"27335\",\n \"address\": \"test@example.com\",\n \"actualStatus\": \"sent\",\n \"notSentCause\": null,\n \"sentDate\": 1773658427452,\n \"opened\": true,\n \"lastOpenedTs\": 1773675603586,\n \"clicked\": true,\n \"lastClickedTs\": 1773675603586,\n \"idbouncecategory\": null,\n \"complainted\": false,\n \"converted\": false,\n \"lastConversionTs\": null,\n \"expectedDeliveryTs\": 1773658412517,\n \"messageRetention\": \"full\",\n \"externalId\": null\n}"}],"_postman_id":"4096bbb4-48b1-43bc-b7e9-f514871d19d8"},{"name":"Get simple message status by external id","id":"17a12548-215e-4733-9bf1-6324ad95f1e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/simplemessages/messagebyexternalid/:externalId","description":"

Get the status of a simple message by external ID

Get information about a simple message by ID

Send a transactional message

Request Body

`options`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Default Value	Description
`idcontact`	Integer	`null`	Lookup contact profile by internal ID.
`iddatabase`	Integer	`null`	If contact not found, renders email as if sent to a contact in this database.
`contactprimarykey`	String	`null`	Lookup contact profile by primary key in the specified database (see `iddatabase`).
`contactprimarykeyoptional`	Boolean	`false`	If contact isn’t found, uses `message.to` as recipient instead of failing. Note: No statistics are recorded if contact is not found.
`usecontactemail`	Boolean	`false`	Override `message.to` with the contact’s email.
`cssinline`	Boolean	`false`	Apply CSS inline to HTML content.
`embeddedimages`	Boolean	`false`	Download and embed images from HTML content.
`idwebsite`	Integer	(default website ID)	Website ID used to render absolute URLs (images, unsubscribe links, etc.).
`usenewsletterastemplate`	Boolean	`false`	Use a communication template (notification template) as the message body.
`renderatsend`	Boolean	`false`	Render the message at send time (preferred with `usenewsletterastemplate`; no DB persistence).
`usehtmlcodeastemplate`	Boolean	`false`	Use provided HTML code as the message body (allows Giotto conditions).
`idnewsletter`	Integer	`null`	Communication template ID for rendering (requires `usenewsletterastemplate=true`).
`newsletterkey`	String	`null`	Communication template key for rendering (requires `usenewsletterastemplate=true`). If both `idnewsletter` and `newsletterkey` are set, `idnewsletter` takes precedence.
`format`	String	`\"html\"`	Message format: `\"html\"`, `\"text\"`, or `\"multipart\"`.
`validatesmslength`	Boolean	`true`	Validate SMS parts count against `maxsmsparts` and account settings.
`maxsmsparts`	Integer	(account max SMS parts)	Maximum allowed SMS parts; messages exceeding this limit are not sent.
`expectedDeliveryTs`	Timestamp	(empty = ASAP)	Schedule message delivery; empty means send immediately.
`temp.xxx`	String	`\"\"`	Set initial value of `temp.xxx` Giotto variables (`[temp:xxx]` syntax).
`messageRetention`	String	`\"minimal\"`	Retention policy: `\"minimal\"` (discard body), `\"full\"` (keep body & headers), `\"reserved\"`.
`externalId`	String	`\"null\"`	Assign an external ID to the message.
`inputparam.xxx`	String	`\"\"`	Set `inputparam.xxx` Giotto variables (`[inputparam:xxx]` syntax).
`nospool`	Boolean	`false`	Attempt to send without spooling for timelier delivery.
`idlanguage`	String	`null`	Language ID: `\"ITA\"`, `\"ENG\"`, `\"FRA\"`, or `null`.
`usecontactcell`	Boolean	`false`	Override `message.to` with contact’s phone number for SMS.

`values`

Field	Type	Default Value	Description
`type`	String	`null`	Message type: `\"email\"` or `\"sms\"`.
`to`	String	`null`	Recipient email address or phone number.
`fromemail`	String	`null`	From header email address (email messages only).
`fromname`	String	`null`	From header name (email messages only).
`replyto`	String	`null`	Reply-To header email address (email messages only).
`subject`	String	`null`	Email subject (email messages only).
`preheader`	String	`null`	Preview text (email messages only).
`charset`	String	`null`	Email charset (email messages only).
`htmlbody`	String	`null`	HTML content (email messages only).
`textbody`	String	`null`	Plain-text content (email messages only).
`from`	String	`null`	SMS sender ID (phone number or name, SMS only).
`smsbody`	String	`null`	SMS message text (SMS only).
`idmessagetype`	Integer	(none)	Transactional message type ID for stats aggregation.
`attachments`	Array	`null`	Array of attachment objects (see below).
`header.xxxx`	String	(none)	Custom header lines, e.g. `header.Message-ID=MyID@server` (email messages only).

Attachment object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`filename`	String	Attachment file name.
`contenttype`	String	MIME type; inferred from filename if omitted.
`body`	String	File content as Base64-encoded string.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}},"urlObject":{"path":["v19","simplemessages","message"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"901d22b2-1e3e-49aa-b8be-9b260987b51e","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"options\": {\n \"usecontactemail\": false,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"fromemail\": \"sender@example.com\",\n \"fromname\": \"Sender Name\",\n \"to\": \"recipient@example.com\",\n \"subject\": \"Test Email\",\n \"htmlbody\": \"This is a test email\"\n }\n}"},"url":"https://ws-mn1.mag-news.it/ws/rest/api/v19/simplemessages/message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messageId\": \"123456\",\n \"address\": \"recipient@example.com\",\n \"actualStatus\": \"waiting\",\n \"sentDate\": \"2023-06-15T10:30:00.000Z\",\n \"opened\": false,\n \"clicked\": false,\n \"complainted\": false,\n \"converted\": false,\n \"messageRetention\": \"full\",\n \"externalId\": null\n}"},{"id":"13186789-7c41-4c7f-b4f0-2627ac4cb7ec","name":"Error Response - Empty From Email","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"options\": {\n \"usecontactemail\": false,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"to\": \"recipient@example.com\",\n \"subject\": \"Test Email\",\n \"htmlbody\": \"This is a test email\"\n }\n}"},"url":"/v19/simplemessages/message"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"an empty fromemail is not valid\"\n}"},{"id":"a2337666-cb85-44a2-857a-bb8c2b52050c","name":"Server Error Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"options\": {\n \"usecontactemail\": false,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"fromemail\": \"sender@example.com\",\n \"fromname\": \"Sender Name\",\n \"to\": \"recipient@example.com\",\n \"subject\": \"Test Email\",\n \"htmlbody\": \"This is a test email\"\n }\n}"},"url":"/v19/simplemessages/message"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal server error\",\n \"message\": \"An unexpected error occurred while processing your request\"\n}"}],"_postman_id":"f153dcc8-d828-41a7-8bff-fdfc700501bb"},{"name":"Send simple message using contact data","id":"f93219f7-8f23-4bfe-b37a-7381a0f36ba7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"options\": {\n \"usecontactemail\": true,\n \"idcontact\": 1,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"fromemail\": \"sender@example.com\",\n \"fromname\": \"Sender Name\",\n \"subject\": \"Test Email for Contact\",\n \"htmlbody\": \"This is a test email for contact\",\n \"attachments\": [\n {\n \"filename\": \"hello.csv\",\n \"contenttype\": \"text/csv\",\n \"body\": \"bmFtZSxlbWFpbAp0ZXN0LHRlc3RAZXhhbXBsZS5jb20=\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/simplemessages/message","description":"

Send a transactional message with an attachment to a platform contact

Send a transactional message using a communication as a template filled with temp vars

\n
Note: If you specify the subject value, you must remove the renderatsend option (and vice versa).
\n

Send transactional SMS message

Send a single SMS message using the same options as the email message request.
See Send simple message options for full details.

Send transactional WhatsApp message

Send a single WhatsApp message using the same options as the email message request.
See Send simple message options for full details.

This is a test email

\n\n\n\n--start--","options":{"raw":{"language":"text"}}},"url":"/v19/simplemessages/mimemessage?recipient=recipient@example.com&cssinline=false&idmessagetype=0&retention=full&destination=frontend","description":"

Send a MIME transactional message

If the message is sent successfully, this function returns the message ID; otherwise it returns an error.

Prerequisites:

Define the mandatory recipient query parameter.
\n
Include the header: Content-Type: message/rfc822.
\n

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`recipient`	String	Recipient email address (mandatory).
`idcontact`	Integer	ID of the contact to link to the message (optional).
`expectedDeliveryTs`	Timestamp	Unix timestamp in milliseconds (default `null`) to schedule future delivery.
`destination`	String	Specifies delivery channel: `frontend` (contact), `backend` (platform user), or `bulk` (Simply-SMTP). Default is `frontend`.
`idmessagetype`	Integer	Message type for statistics aggregation.
`cssinline`	Boolean	Whether to apply CSS inline to the HTML content.
`retention`	String	Retention policy: `minimal` (discard body), `full` (store body & headers), or `reserved`.
`externalId`	String	Custom external ID (up to 1000 chars) for mapping the message to another system.

Result

Returns a JSON object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`ok`	`true` or `false`
`error`	Error description (if `ok` is `false`)
`messageId`	ID of the transactional message (if `ok` is `true`)

This is a test email

\n\n\n\n--start--"},"url":{"raw":"/v19/simplemessages/mimemessage?recipient=recipient@example.com&cssinline=false&idmessagetype=0&retention=full&destination=frontend","host":[""],"path":["v19","simplemessages","mimemessage"],"query":[{"key":"recipient","value":"recipient@example.com"},{"key":"cssinline","value":"false"},{"key":"idmessagetype","value":"0"},{"key":"retention","value":"full"},{"key":"destination","value":"frontend"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messageId\": \"1\",\n \"ok\": true,\n \"error\": \"\"\n}"},{"id":"3b812765-8839-4d35-ac5f-d4bf512d9214","name":"Error Response - Empty From Email","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"message/rfc822"}],"body":{"mode":"raw","raw":"Subject: Test Email\nTo: recipient@example.com\nMIME-Version: 1.0\nContent-Type: text/plain; charset=utf-8\n\nThis is a test email"},"url":{"raw":"/v19/simplemessages/mimemessage?recipient=recipient@example.com&cssinline=false&idmessagetype=0&retention=full&destination=frontend","host":[""],"path":["v19","simplemessages","mimemessage"],"query":[{"key":"recipient","value":"recipient@example.com"},{"key":"cssinline","value":"false"},{"key":"idmessagetype","value":"0"},{"key":"retention","value":"full"},{"key":"destination","value":"frontend"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messageId\": null,\n \"ok\": false,\n \"error\": \"Empty from in body message\"\n}"},{"id":"f8ab6b0d-aa46-4574-a170-69cf1f54f380","name":"Server Error Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"message/rfc822"}],"body":{"mode":"raw","raw":"From: \"MN test\" \nMessage-ID: <5bec11c119194c14999e592feb46e3cf@localhost>\nSubject: Test Email\nTo: recipient@example.com\nMIME-Version: 1.0\nContent-Type: multipart/alternative; \n boundary=\"start\"\n\n--start\nContent-type: text/html; charset=iso-8859-1\nContent-Transfer-Encoding: quoted-printable\n\n\n\n\n\n

This is a test email

\n\n\n\n--start--"},"url":{"raw":"/v19/simplemessages/mimemessage?recipient=recipient@example.com&cssinline=false&idmessagetype=0&retention=full&destination=frontend","host":[""],"path":["v19","simplemessages","mimemessage"],"query":[{"key":"recipient","value":"recipient@example.com"},{"key":"cssinline","value":"false"},{"key":"idmessagetype","value":"0"},{"key":"retention","value":"full"},{"key":"destination","value":"frontend"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"messageId\": null,\n \"ok\": false,\n \"error\": \"Error: Internal server error\"\n}"}],"_postman_id":"8f1bfbd4-5b6b-43ed-95f3-b0d9e77e70ac"},{"name":"Batch Send simple messages","id":"670a934d-0618-41ad-902f-9dff50463ce3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"messages\": [\n {\n \"options\": {\n \"usecontactemail\": false,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"fromemail\": \"sender@example.com\",\n \"fromname\": \"Sender Name\",\n \"to\": \"recipient1@example.com\",\n \"subject\": \"Test Email 1\",\n \"htmlbody\": \"This is a test email 1\"\n }\n },\n {\n \"options\": {\n \"usecontactemail\": false,\n \"nospool\": false\n },\n \"values\": {\n \"type\": \"email\",\n \"fromemail\": \"sender@example.com\",\n \"fromname\": \"Sender Name\",\n \"to\": \"recipient2@example.com\",\n \"subject\": \"Test Email 2\",\n \"htmlbody\": \"This is a test email 2\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v19/simplemessages/messages","description":"

Send multiple simple messages in a batch.

Options are the same as Send simple messages.

\n
Note: What magnews refers to as “Transactional messages” are called Simple messages in the API.
\n

\n","_postman_id":"579b9e5e-f32c-424b-a92d-eda247ee8d70","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Communications","item":[{"name":"Get newsletter basic information","id":"8ae64365-340f-498e-9c37-a3e1be19f2b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/newsletters/:id/info","description":"

Get newsletter (communication or transactional template) basic information such as name, type, status, thumbnail image, channel details (like email headers), etc.

the newsletter id (communication or template id)

\n","type":"text/plain"},"type":"any","value":"372","key":"id"}]}},"response":[{"id":"c5c84827-0e24-49a8-8976-581d7689c5bc","name":"Communication example","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/newsletters/:id/info","host":[""],"path":["v19","newsletters",":id","info"],"variable":[{"key":"id","value":"1","description":"the communication id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 25 Jul 2025 07:48:39 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 101,\n \"name\": \"Summer Deals Newsletter\",\n \"type\": \"communication\",\n \"status\": \"draft\",\n \"idjourney\": 202,\n \"journey\": \"Summer Campaign 2025\",\n \"idworkflow\": 0,\n \"idlandingpage\": 0,\n \"creationDate\": 1730707200000,\n \"lastUpdateDate\": 1731285600000,\n \"sentDate\": null,\n \"scheduledSendDate\": null,\n \"channels\": [\n {\n \"preheader\": \"Save big on your summer essentials\",\n \"from_email\": \"offers@magnews.com\",\n \"channel\": \"email\",\n \"absplit\": false,\n \"from_name\": \"Magnews Marketing Team\"\n }\n ],\n \"thumbnail\": \"http://myfrontendinstance/newsletterthumb/6/101?_cv=704942055&s=b3ffd470b2e15490d33eb314a1e7102ef6fe760c401120982a9df241fdcf849e\"\n}\n"},{"id":"d35e8d48-50b6-4f1f-a1a4-10d37e0e1f38","name":"Transactional example","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/newsletters/:id/info","host":[""],"path":["v19","newsletters",":id","info"],"variable":[{"key":"id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 25 Jul 2025 09:40:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 337,\n \"name\": \"WhatsApp test Rest API\",\n \"type\": \"transactional\",\n \"status\": \"active\",\n \"idjourney\": 11,\n \"journey\": \"My journey\",\n \"idworkflow\": 0,\n \"idlandingpage\": 0,\n \"creationDate\": 1725360693687,\n \"lastUpdateDate\": 1725370784810,\n \"sentDate\": null,\n \"scheduledSendDate\": null,\n \"channels\": [\n {\n \"channel\": \"whatsappbusiness\"\n }\n ],\n \"thumbnail\": \"http://myfrontendsite/newsletterthumb/6/337?_cv=1419749233&s=4db29bf46d558cd9f5226e1fd19bc547f04a7060526747fa4c799122aab8288f\"\n}"}],"_postman_id":"8ae64365-340f-498e-9c37-a3e1be19f2b2"},{"name":"Update newsletter basic information","id":"4d20e0ed-6517-49cf-8636-853910d838a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Newsletter Promozionale Gennaio 2026\",\n \"subject\": \"Sconti esclusivi solo per te!\",\n \"fromEmail\": \"marketing@example.com\",\n \"fromName\": \"Team Marketing MagNews\",\n \"emailReplyTo\": \"supporto@example.com\",\n \"preheader\": \"Scopri le offerte riservate ai nostri migliori clienti.\",\n \"usersDescription\": \"Campagna per il lancio dei saldi invernali 2026.\",\n \"contactsDescription\": \"Comunicazioni periodiche su sconti e promozioni.\"\n}","options":{"raw":{"language":"json"}}},"url":"/v19/newsletters/:id/update","description":"

Updates an existing newsletter. This endpoint allows modifying fields such as the name, subject, sender information, and descriptions. If the newsletter has an A/B split test enabled, you can target a specific variant for the update.

Usage Notes

Transactional Newsletters: The newsletterKey field can only be set if the newsletter is configured as a transactional template.
\n
A/B Split Test: If the newsletter has an active A/B test, the subject, preheader, fromEmail and fromName fields will update the specific variant if the endpoint is called with the absplitversion query parameter (e.g., /update?absplitversion=b).
\n
Optionality: It is not necessary to send all fields; you can include only the ones you actually intend to modify in the JSON body.
\n

the newsletter id (communication or template id)

\n","type":"text/plain"},"type":"any","value":"372","key":"id"}]}},"response":[{"id":"658afb5c-ae96-4d72-b4f1-143337b40c58","name":"Update newsletter basic information","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Newsletter Promozionale Gennaio 2026\",\n \"subject\": \"Sconti esclusivi solo per te!\",\n \"fromEmail\": \"marketing@example.com\",\n \"fromName\": \"Team Marketing MagNews\",\n \"emailReplyTo\": \"supporto@example.com\",\n \"preheader\": \"Scopri le offerte riservate ai nostri migliori clienti.\",\n \"usersDescription\": \"Campagna per il lancio dei saldi invernali 2026.\",\n \"contactsDescription\": \"Comunicazioni periodiche su sconti e promozioni.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v19/newsletters/:id/update","host":[""],"path":["v19","newsletters",":id","update"],"variable":[{"key":"id","value":"372","description":"the newsletter id (communication or template id)"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 26 Jan 2026 15:29:12 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4d20e0ed-6517-49cf-8636-853910d838a7"},{"name":"Send communication (create delivery)","id":"c843cd45-f4a5-455e-8007-35a17b892c8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"enableEmail\": true,\n \"skipConfirmation\": true,\n \"target\": [\n 129\n ],\n \"schedule\": {\n \"type\": \"immediate\"\n },\n \"options\": {\n \"failOnEmptyTarget\": true,\n \"useAllChannels\": true,\n \"email\": {\n \"useNewsletterOptions\": true,\n \"allowDuplicatedRecipients\": false\n },\n \"additionalTargetFilterQuery\": \"SELECT * FROM CONTACTS WHERE email like '%diennea.com'\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/communications/communication/:id/send","description":"

Triggers the sending of a communication (newsletter) to a specified target. This creates a new Delivery instance. You can configure scheduling (immediate, postponed, periodic, or partitioned) and various delivery options for different channels (email, sms).

Request body includes this fields:

enableEmail: Whether to enable email channel.
\n
enableSms: Whether to enable sms channel.
\n
customChannels: List of custom channels to enable (comma separated).
\n
target: List of target group IDs.
\n
skipConfirmation: If true, skips the confirmation step if required by the campaign.
\n
schedule: Scheduling configuration (see below)
\n
options: Delivery options (see below)
\n

Scheduling configuration:

type: Type of schedule: immediate, scheduled, periodic, partitioned.
\n
period: For periodic: daily, weekly, monthly, yearly.
\n
year, month, day, hour, minute: Date and time components for the schedule.
\n
sendtimeOptimization: If true, enable send-time optimization.
\n
useContactsTimeZone: If true, use the contacts' time zone for delivery time.
\n
weekDays: For weekly period: monday, tuesday,..
\n
partitions: For partitioned deliveries: list of { \"delta\": long, \"percent\": int }
\n
startInterval, endInterval: Dates used to define a range for periodic deliveries.
\n

Options:

recall: Whether this is a recall delivery.
\n
failOnEmptyTarget: If true, the request fails if the target has no contacts.
\n
ignoreUserPreferencesOnChannels: Ignore global user channel preferences and send the message anyway.
\n
additionalTargetFilterQuery: MQL filter to further restrict the target.
\n
email: Email specific options (subject override, encoding, images embedding, etc.).
\n
sms: SMS specific options (from override, encoding).
\n
speedLimiter: Limit the sending speed (enabled, maxSpeedPerMinute).
\n
authorization: Configure authorization workflow.
\n
report: Configure delivery report notification.
\n

Response:

iddelivery: id of the delivery to use in /delivery/:iddelivery/status|pause|stop|resume endpoints
\n
errors: detailed errors (no channels enabled for communication, missing required parameters, no target for sending,...)
\n

Retrieves the detailed status and configuration of a specific delivery. Returns information about the current state, scheduling, and target audience.

Response Body

The response is a JSON object with the following fields:

iddelivery (int): The unique identifier of the delivery.
\n
idnewsletter (int): The identifier of the newsletter associated with the delivery.
\n
trial (boolean): Indicates if it's a trial delivery.
\n
status (string): The current status of the delivery. Possible values are:
\n
- unconfirmed: The delivery has not been confirmed.
  \n
- scheduled: The delivery is waiting to be sent at the scheduled time.
  \n
- sending: The delivery is being prepared or sent.
  \n
- error: An error occurred during preparation or sending.
  \n
- finished: The delivery has completed successfully.
  \n
- paused: The delivery has been paused.
  \n
- stopped: The delivery was interrupted or stopped.
  \n
\n
target (list of integers): A list of audience IDs that are the target of this delivery.
\n
targetUsesAdditionalFilter (boolean): Indicates if additional filters are applied to the target
\n
requestedMessages (map): A map showing the number of requested messages per channel (e.g., \"email\", \"sms\").
\n
startDate (date): The timestamp when the delivery started or is scheduled to start.
\n
schedule (object): An object describing the scheduling configuration.
\n

The unique integer ID of the delivery

\n","type":"text/plain"},"type":"any","value":"81","key":"iddelivery"}]}},"response":[{"id":"01396769-3aa2-41c2-8e40-22f99652c2e2","name":"Get delivery status","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/deliveries/delivery/:iddelivery/status","host":[""],"path":["v19","deliveries","delivery",":iddelivery","status"],"variable":[{"key":"iddelivery","value":"81","description":"The unique integer ID of the delivery"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Jan 2026 14:51:23 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"iddelivery\": 81,\n \"idnewsletter\": 372,\n \"trial\": false,\n \"status\": \"sending\",\n \"target\": [\n 129\n ],\n \"targetUsesAdditionalFilter\": true,\n \"requestedMessages\": {\n \"sms\": 0,\n \"email\": 12\n },\n \"startDate\": 1769176616187,\n \"schedule\": {\n \"type\": \"immediate\"\n }\n}"}],"_postman_id":"f120dc7e-0267-47a2-b523-3cd26a484a30"},{"name":"Pause delivery","id":"841bc179-7299-4d21-9483-2b692c1b030a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v19/deliveries/delivery/:iddelivery/pause","description":"

Pauses an active delivery. Suspends the execution of a delivery. The delivery must be active and not yet completed or moved to history. Requires \"send newsletter\" permissions.

The unique integer ID of the delivery

\n","type":"text/plain"},"type":"any","value":"82","key":"iddelivery"}]}},"response":[{"id":"9e0716b0-5151-4359-9772-712386132d74","name":"Pause delivery","originalRequest":{"method":"POST","header":[],"url":{"raw":"/v19/deliveries/delivery/:iddelivery/pause","host":[""],"path":["v19","deliveries","delivery",":iddelivery","pause"],"variable":[{"key":"iddelivery","value":"82","description":"The unique integer ID of the delivery"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 26 Jan 2026 11:14:18 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"841bc179-7299-4d21-9483-2b692c1b030a"},{"name":"Resume delivery","id":"8d725097-d885-4a5f-a37e-196285202f04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v19/deliveries/delivery/:iddelivery/resume","description":"

Resumes a previously paused delivery. Restarts a delivery that was suspended. It sets the resume time to the current system time. Requires \"send newsletter\" permissions.

The unique integer ID of the delivery

\n","type":"text/plain"},"type":"any","value":"82","key":"iddelivery"}]}},"response":[{"id":"7221eb5a-ac92-4990-bb05-300e5d1ccac5","name":"Resume delivery","originalRequest":{"method":"POST","header":[],"url":{"raw":"/v19/deliveries/delivery/:iddelivery/resume","host":[""],"path":["v19","deliveries","delivery",":iddelivery","resume"],"variable":[{"key":"iddelivery","value":"82","description":"The unique integer ID of the delivery"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 26 Jan 2026 11:14:39 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8d725097-d885-4a5f-a37e-196285202f04"},{"name":"Stop delivery","id":"02ffa33f-e3ee-4b72-9806-8eebdf079fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v19/deliveries/delivery/:iddelivery/stop","description":"

Stops an active delivery. This method attempts to cancel an ongoing delivery. It requires \"send newsletter\" permissions for the campaign associated with the delivery.

The unique integer ID of the delivery

\n","type":"text/plain"},"type":"any","value":"82","key":"iddelivery"}]}},"response":[{"id":"51991bed-b335-40ab-9cbf-59e9bae15d25","name":"Stop delivery","originalRequest":{"method":"POST","header":[],"url":{"raw":"/v19/deliveries/delivery/:iddelivery/stop","host":[""],"path":["v19","deliveries","delivery",":iddelivery","stop"],"variable":[{"key":"iddelivery","value":"82","description":"The unique integer ID of the delivery"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Length","value":"0"},{"key":"Date","value":"Mon, 26 Jan 2026 11:14:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"02ffa33f-e3ee-4b72-9806-8eebdf079fc8"},{"name":"Query deliveries","id":"96abab59-cb5d-46ff-a45f-cdc1535e764f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/deliveries/query?query=SELECT * from DELIVERIES where idnewsletter=5","description":"

Queries delivery records that satisfy an MQL query; a delivery represents a single instance created each time a communication is sent, whether for testing or for a production send.

The response is a JSON array of objects containing:

iddelivery: ID of the delivery
\n
idnewsletter: ID of the associated communication
\n
trial: whether the delivery is a test (trial)
\n
status: a value between \"sending\", \"error\", \"unconfirmed\", \"scheduled\", \"paused\", \"finished\", \"stopped\"
\n
target: list of target audience IDs
\n
targetUseAdditionalFilter: whether an additional filter is applied to the target
\n
requestedMessages: count of requested messages per channel (ie: 'email': 23, 'sms': 2)
\n
startDate: start date and time of delivery (unix ts milliseconds)
\n
schedule: the scheduling configuration
\n

The schedule object contains a type field which determines the structure:

immediate: No additional fields.
\n
scheduled: Includes year, month, day, hour, minute, sendTimeOptimization, useContactsTimeZone.
\n
periodic: Includes period (daily, weekly, monthly, yearly), month, day, hour, minute, weekDays, useContactsTimeZone, sendTimeOptimization, startInterval, endInterval.
\n
partitioned: Includes partitions (a list of objects with delta and percent).
\n

MQL query to filter deliveries

\n","type":"text/plain"},"key":"query","value":"SELECT * from DELIVERIES where idnewsletter=5"}],"variable":[]}},"response":[{"id":"a3eb1f66-3c54-4fc6-9586-31f9d4d70e08","name":"Query communication deliveries","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/deliveries/query?query=SELECT * from DELIVERIES where idnewsletter=5","host":[""],"path":["v19","deliveries","query"],"query":[{"key":"query","value":"SELECT * from DELIVERIES where idnewsletter=5","description":"SQL-like query to filter transactionals"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Fri, 23 Jan 2026 11:23:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"iddelivery\": 2,\n \"idnewsletter\": 5,\n \"trial\": false,\n \"status\": \"finished\",\n \"target\": [\n 8\n ],\n \"targetUsesAdditionalFilter\": false,\n \"requestedMessages\": {\n \"sms\": 1,\n \"email\": 0\n },\n \"startDate\": 1487852029587,\n \"schedule\": {\n \"type\": \"immediate\"\n }\n }\n]"}],"_postman_id":"96abab59-cb5d-46ff-a45f-cdc1535e764f"}],"id":"ba2ca151-4be3-47bd-910e-1281e8238e00","description":"

\n
The Newsletters section includes both marketing communications and transactional templates.
\n

\n","_postman_id":"ba2ca151-4be3-47bd-910e-1281e8238e00","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Contacts","item":[{"name":"Find contact by id","id":"be0fb330-8534-4116-a736-1b7d77e37c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/contacts/contact/:idcontact","description":"

Find a contact by ID

Return a list of contacts matching the specified query.

Writing queries

See the Query documentation for more details on how to write queries.

Creates or updates a contact by providing the idcontact.

Options

You can map these options in the json body of the request, under \"options\" object.

Option	Type	Default	Description
iddatabase	Integer		Database ID for the new contact
sendemail	Boolean	false	Request to send an email to the contact
sendemailonactions	String (comma-separated)	insert, restore	Actions for which to send email, depending on the merge result: `insert`, `update`, `nothing`, `reactivate`, `restore`, `subscription_confirm`, `update`, `delete`, `suspend`
idtemplate	Integer	null	ID of the template of the transactional message to use for the email
enterworkflow	Boolean	false	Request the contact to enter an automated flow
enterworkflowonactions	String (comma-separated)	insert, restore	Actions triggering entrance to automated flow
key	String	null	Entry point ID for automated flow. If `idworkflow` not specified, all flows with the entry point are triggered
idworkflow	Integer	0	Specific workflow ID to enter. If 0, all matching flows are triggered
wf.	Primitive types		Session context variable, e.g., `\"wf.source\": \"website\"`
denyupdatecontact	Boolean	false	Prevents contact update
forceallowrestorecontactonupdate	Boolean	false	Allows reactivation even with `denyupdatecontact = true`
denysubscribenewcontact	Boolean	false	Prevents subscription of new contacts
denysubscribeunsubscribedcontact	Boolean	false	Denies reactivation of unsubscribed contacts
messageRetention	String	\"minimal\"	Retention policy: `\"minimal\"`, `\"full\"`, or `\"reserved\"`
lookuprelations	Boolean	false	If true, uses logical keys for relational fields
addToSimpleGroup	Integer		Adds contact to the specified static audience
removeFromSimpleGroup	Integer		Removes contact from the specified static audience
returnwebtrackingid	Boolean	false	Returns Web Tracking session ID
storeEvent	String		This option requests to register an event. Only valid value: `\"contactUnsubscribed\"`; requires `messageRef`
messageRef	String		Message reference for `storeEvent`

Values

You can map these values in the JSON body of the request, under the values object.

The values field contains the data to be associated with the contact. Keys must match the field IDs (e.g., email, name, status, etc.).

For the status field, you can specify one of the following values: subscribed, unsubscribed, unconfirmed or suspended.

⚠️ For decimal numbers, always use a JSON string, and format the decimal separator according to the international settings of the user performing the operation. Valid examples: \"1234.56\" or \"1234,56\".

For multivalue fields, use a string containing a comma-separated list of values, like this:
\"MULTIVALUESFIELD\": \"\\\"value1\\\",\\\"value2\\\"\".

Response

The API response contains the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
`ok`	Boolean	`true` if the operation was successful
`pk`	String	Primary key of the contact
`idcontact`	Integer	Unique ID of the contact
`action`	String	Executed action: one of `insert`, `update`, `delete`, `nothing`, `reactivate`, `restore`, `subscription_confirm`, `suspend`
`errors`	Array	List of possible errors; each includes a type and the related field
`sendemail`	Object	Result of the email sending (if requested)
`sendemail.emailsent`	Boolean	`true` if the email was sent
`sendemail.emailaddress`	String	Email address of the recipient
`sendemail.idsimplemessage`	String	ID of the transactional message
`enterworkflow`	Object	Result of the automated flow entry request
`enterworkflow.workflowentered`	Boolean	`true` if at least one automated flow session was triggered
`enterworkflow.idworkflowsessions`	Array of Integer	List of session IDs for the triggered flows

Update or insert a contact by matching the database primary key value (e.g., email or username).

For json body specification refer to Merge contact options and values.

Subscribe a contact or change the contact status to subscribed if the contact already exists.

For json body specification refer to Merge contact options and values.

Unsubscribe a contact.

For json body specification refer to Merge contact options and values.

Permanently deletes a single contact and all associated data.

(boolean, optional) If not specified, defaults to true. When true, also deletes the contact’s form submissions.

\n","type":"text/plain"},"key":"dropformsdata","value":"true"}],"variable":[{"type":"any","value":"","key":"idcontact"}]}},"response":[{"id":"c3317c9c-0570-46fd-bd83-4be5d9fe9c47","name":"Success response","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"/v19/contacts/delete/:idcontact?dropformsdata=true","host":[""],"path":["v19","contacts","delete",":idcontact"],"query":[{"key":"dropformsdata","value":"true","description":"(boolean, optional) If not specified, defaults to true. When true, also deletes the contact’s form submissions."}],"variable":[{"key":"idcontact","value":"104"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Date","value":"Thu, 13 Nov 2025 08:02:41 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null},{"id":"ceffc05d-1da7-4e53-b345-dd693f590f92","name":"Delete contact (contact not found)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"/v19/contacts/delete/:idcontact?dropformsdata=true","host":[""],"path":["v19","contacts","delete",":idcontact"],"query":[{"key":"dropformsdata","value":"true","description":"(boolean, optional) If not specified, defaults to true. When true, also deletes the contact’s form submissions."}],"variable":[{"key":"idcontact","value":"103"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 13 Nov 2025 08:01:49 GMT"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"connection","value":"close"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"contact not found or missing permissions\",\n \"debugMessage\": \"contact not found or missing permissions\"\n}"}],"_postman_id":"f3cc25e4-285b-4a64-8392-2405ac31ec02"},{"name":"Batch merge contacts","id":"ae65bd86-2571-4439-bbf8-07d2e6b58cc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"iddatabase\": 1,\n \"contacts\": [\n {\n \"values\": [\n {\n \"field\": \"email\",\n \"value\": \"contact1@example.com\"\n },\n {\n \"field\": \"name\",\n \"value\": \"John Doe\"\n }\n ]\n },\n {\n \"values\": [\n {\n \"field\": \"email\",\n \"value\": \"contact2@example.com\"\n },\n {\n \"field\": \"name\",\n \"value\": \"Jane Doe\"\n }\n ]\n }\n ],\n \"options\": {\n \"updateIfExists\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/contacts/batchmerge","description":"

Merge multiple contacts in a batch.

For json body specification refer to Merge contact options and values.

Deletes multiple contacts in batch. A contact can be identified either by its unique ID or by the pair primary key + database ID. Contacts are deduplicated before processing. The optional query parameter dropFormsData (boolean, defaults to true) works as described above, also deletes the contact’s form submissions.

If allowPartialDelete is set to true, contacts that cannot be deleted are skipped, while the others are removed. The request completes with a 200 response and includes a summary report.

Find an audience by ID

Return a list of audiences matching the specified query.

Writing queries

See the Query documentation for more details on how to write queries.

Note: the groups table refers to audiences.

Creates a new static audience in a specific database. You can optionally set an expiration date for the audience.

Deletes an existing audience. Before deletion, the system checks if the audience is currently in use within the platform (e.g., in Journeys, Workflow limits, or as a target for other audiences). If it is in use, the deletion will fail with a list of references where the audience is used.

The unique integer ID of the audience to delete.

\n","type":"text/plain"},"type":"any","value":"","key":"idaudience"}]}},"response":[],"_postman_id":"6ed27491-f197-4e66-80b3-c2166a273e99"}],"id":"2e71aa1c-f62e-4f49-8223-3ff1a4c9f441","_postman_id":"2e71aa1c-f62e-4f49-8223-3ff1a4c9f441","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Web Tracking","item":[{"name":"Get web tracking for contact","id":"32445336-2c03-4830-9c32-a6258349e895","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/webtracking/contact/:idcontact","description":"

Get web tracking information for a contact by ID

Query web tracking information for contacts using a query string

Writing queries

See the Query documentation for more details.

Get a summary of communication statistics with optional parameters. If the communication is archived, requests for a detailed contacts report (i.e., including `query` or `idaudience` parameters) will return a 400 Bad Request error.

The NaN value in rates, indicates that the rate cannot be computed because the denominator is zero.

Channel to filter by: email, sms, fax, or a custom channel name (default: first available channel for the newsletter)

\n","type":"text/plain"},"key":"channel","value":"whatsappbusiness"},{"disabled":true,"description":{"content":"

MQL query to filter contacts

\n","type":"text/plain"},"key":"query","value":"select * from contacts where email like '%gmail.com'"},{"disabled":true,"description":{"content":"

ID of a contact's audience to filter by

\n","type":"text/plain"},"key":"idaudience","value":"1"},{"disabled":true,"description":{"content":"

ID of the delivery to filter by

\n","type":"text/plain"},"key":"iddelivery","value":"1"},{"disabled":true,"description":{"content":"

A/B split version: a or b

\n","type":"text/plain"},"key":"absplitversion","value":"b"},{"disabled":true,"description":{"content":"

Whether to calculate conversion goal statistics

\n","type":"text/plain"},"key":"conversiongoals","value":"true"}],"variable":[{"type":"any","value":"53","key":"idnewsletter"}]}},"response":[{"id":"80e078dd-f9bd-4ebc-9087-a12d9882ee8a","name":"Communication summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/newsletter/:idnewsletter","host":[""],"path":["v19","insights","newsletter",":idnewsletter"],"query":[{"key":"query","value":"select * from contacts where email like '%gmail.com'","description":"MQL query to filter contacts","type":"text","disabled":true},{"key":"idaudience","value":"1","description":"ID of a contact's audience to filter by","type":"text","disabled":true},{"key":"iddelivery","value":"1","description":"ID of the delivery to filter by","type":"text","disabled":true},{"key":"absplitversion","value":"b","description":"A/B split version: a or b","type":"text","disabled":true},{"key":"conversiongoals","value":"true","description":"Whether to calculate conversion goal statistics","type":"text","disabled":true}],"variable":[{"key":"idnewsletter","value":"762"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:3079"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 15 Jan 2026 11:07:29 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"idnewsletter\": 762,\n \"channel\": \"email\",\n \"firstSentAt\": 1709274646985,\n \"lastSentAt\": 1709275053263,\n \"deliveryRate\": 98.16,\n \"bounceRate\": 1.84,\n \"openRate\": 9.79,\n \"clickToOpenRate\": 13.04,\n \"clickRate\": 1.28,\n \"conversionRate\": 0,\n \"clickPerClicked\": 152.33,\n \"conversionToClickRate\": 0.36,\n \"reachedRate\": 98.16,\n \"openersRate\": 9.79,\n \"clickersToOpenersRate\": 13.04,\n \"clickersRate\": 1.28,\n \"convertersRate\": 0,\n \"messagesSent\": 22262,\n \"messagesReceived\": 21852,\n \"messagesOpened\": 2140,\n \"messagesUnreliableOpened\": 3418,\n \"messagesClicked\": 279,\n \"messagesConverted\": 1,\n \"messagesWithUnsubscribeClicks\": 24,\n \"messagesWithSpamReports\": 0,\n \"messagesForwarded\": 0,\n \"messagesHardBounced\": 14,\n \"messagesSoftBounced\": 396,\n \"recipients\": 22262,\n \"reached\": 21852,\n \"openers\": 2140,\n \"unreliableOpeners\": 3418,\n \"clickers\": 279,\n \"converters\": 1,\n \"unsubscribers\": 24,\n \"spamReporters\": 0,\n \"forwarders\": 0,\n \"totalOpens\": 3368,\n \"totalUnreliableOpens\": 10290,\n \"totalClicks\": 425,\n \"totalConversions\": 1,\n \"totalUnsubscribes\": 24,\n \"totalSpamReports\": 0,\n \"totalForwards\": 0,\n \"contents\": [\n {\n \"idcontent\": 7001,\n \"name\": \"Product 2\",\n \"clickers\": 50,\n \"totalClicks\": 64,\n \"messagesClicked\": 50,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/ae1020_c-2218.html\"\n },\n {\n \"idcontent\": 6995,\n \"name\": \"Product 1\",\n \"clickers\": 103,\n \"totalClicks\": 132,\n \"messagesClicked\": 103,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/sr1001_c-2214.html\"\n },\n {\n \"idcontent\": 7000,\n \"name\": \"Pinterest\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.pinterest.com/example\"\n },\n {\n \"idcontent\": 6999,\n \"name\": \"Instagram\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.instagram.com/example\"\n },\n {\n \"idcontent\": 7002,\n \"name\": \"Product 2\",\n \"clickers\": 18,\n \"totalClicks\": 23,\n \"messagesClicked\": 18,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/sr1001_c-2117.html\"\n },\n {\n \"idcontent\": 6997,\n \"name\": \"https://www.example.com/nuova-collezione/\",\n \"clickers\": 105,\n \"totalClicks\": 119,\n \"messagesClicked\": 105,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/nuova-collezione/\"\n },\n {\n \"idcontent\": 6996,\n \"name\": \"Product 3\",\n \"clickers\": 73,\n \"totalClicks\": 83,\n \"messagesClicked\": 73,\n \"converters\": 1,\n \"totalConversions\": 1,\n \"messagesConverted\": 1,\n \"url\": \"https://www.example.com/ae1020_c-2215.html\"\n }\n ],\n \"conversionGoalStats\": []\n}"},{"id":"8dc3e452-fba6-4b34-acb3-3974547b45eb","name":"Filtered by contacts's query","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/newsletter/:idnewsletter?query=SELECT * FROM CONTACTS WHERE email is not null","host":[""],"path":["v19","insights","newsletter",":idnewsletter"],"query":[{"key":"query","value":"SELECT * FROM CONTACTS WHERE email is not null"}],"variable":[{"key":"idnewsletter","value":"53"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 25 Jul 2025 09:40:52 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"idnewsletter\": 53,\n \"channel\": \"email\",\n \"firstSentAt\": 1606217684913,\n \"lastSentAt\": 1606234943583,\n \"deliveryRate\": 100,\n \"bounceRate\": 0,\n \"openRate\": 0,\n \"clickToOpenRate\": \"NaN\",\n \"clickRate\": 0,\n \"conversionRate\": 0,\n \"clickPerClicked\": \"NaN\",\n \"conversionToClickRate\": \"NaN\",\n \"reachedRate\": 100,\n \"openersRate\": 0,\n \"clickersToOpenersRate\": \"NaN\",\n \"clickersRate\": 0,\n \"convertersRate\": 0,\n \"messagesSent\": 3,\n \"messagesReceived\": 3,\n \"messagesOpened\": 0,\n \"messagesUnreliableOpened\": 0,\n \"messagesClicked\": 0,\n \"messagesConverted\": 0,\n \"messagesWithUnsubscribeClicks\": 0,\n \"messagesWithSpamReports\": 0,\n \"messagesForwarded\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 0,\n \"recipients\": 1,\n \"reached\": 1,\n \"openers\": 0,\n \"unreliableOpeners\": 0,\n \"clickers\": 0,\n \"converters\": 0,\n \"unsubscribers\": 0,\n \"spamReporters\": 0,\n \"forwarders\": 0,\n \"totalOpens\": 0,\n \"totalUnreliableOpens\": 0,\n \"totalClicks\": 0,\n \"totalConversions\": 0,\n \"totalUnsubscribes\": 0,\n \"totalSpamReports\": 0,\n \"totalForwards\": 0,\n \"contents\": [],\n \"conversionGoalStats\": []\n}"},{"id":"42600699-7023-4b7c-b51d-354d72c0e81c","name":"With conversion goals","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/newsletter/:idnewsletter?conversiongoals=true","host":[""],"path":["v19","insights","newsletter",":idnewsletter"],"query":[{"key":"query","value":"select * from contacts where email like '%gmail.com'","description":"MQL query to filter contacts","type":"text","disabled":true},{"key":"idaudience","value":"1","description":"ID of a contact's audience to filter by","type":"text","disabled":true},{"key":"iddelivery","value":"1","description":"ID of the delivery to filter by","type":"text","disabled":true},{"key":"absplitversion","value":"b","description":"A/B split version: a or b","type":"text","disabled":true},{"key":"conversiongoals","value":"true","description":"Whether to calculate conversion goal statistics"}],"variable":[{"key":"idnewsletter","value":"511"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:9"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Thu, 13 Nov 2025 08:29:11 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"idnewsletter\": 511,\n \"channel\": \"email\",\n \"firstSentAt\": 1725875118426,\n \"lastSentAt\": 1725875118891,\n \"deliveryRate\": 100,\n \"bounceRate\": 0,\n \"openRate\": 100,\n \"clickToOpenRate\": 100,\n \"clickRate\": 100,\n \"conversionRate\": 100,\n \"clickPerClicked\": 250,\n \"conversionToClickRate\": 100,\n \"reachedRate\": 100,\n \"openersRate\": 100,\n \"clickersToOpenersRate\": 100,\n \"clickersRate\": 100,\n \"convertersRate\": 100,\n \"messagesSent\": 4,\n \"messagesReceived\": 4,\n \"messagesOpened\": 4,\n \"messagesUnreliableOpened\": 0,\n \"messagesClicked\": 4,\n \"messagesConverted\": 4,\n \"messagesWithUnsubscribeClicks\": 0,\n \"messagesWithSpamReports\": 0,\n \"messagesForwarded\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 0,\n \"recipients\": 4,\n \"reached\": 4,\n \"openers\": 4,\n \"unreliableOpeners\": 0,\n \"clickers\": 4,\n \"converters\": 4,\n \"unsubscribers\": 0,\n \"spamReporters\": 0,\n \"forwarders\": 0,\n \"totalOpens\": 18,\n \"totalUnreliableOpens\": 0,\n \"totalClicks\": 10,\n \"totalConversions\": 4,\n \"totalUnsubscribes\": 0,\n \"totalSpamReports\": 0,\n \"totalForwards\": 0,\n \"contents\": [\n {\n \"idcontent\": 1305,\n \"name\": \"Example.com\",\n \"clickers\": 1,\n \"totalClicks\": 1,\n \"messagesClicked\": 1,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com\"\n },\n {\n \"idcontent\": 1306,\n \"name\": \"Contact:CAMPO\",\n \"clickers\": 1,\n \"totalClicks\": 2,\n \"messagesClicked\": 1,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://[contact:CAMPO]\"\n }\n ],\n \"conversionGoalStats\": [\n {\n \"idgoal\": 4,\n \"conversions\": 4,\n \"conversionRate\": 100,\n \"lastConversion\": 1725877397000,\n \"totalValue\": 468.99,\n \"averageValue\": 117.2475,\n \"goalName\": \"Magento\",\n \"currency\": \"€\"\n }\n ]\n}"}],"_postman_id":"d05af57a-48d0-4e03-a1ec-3f6b276c1be2"},{"name":"Communication summaries","id":"32f28189-8ea0-4900-86cb-ae74bd9a035d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/insights/newsletters?queryNewsletter=SELECT * from NEWSLETTERS where template=0 AND sentdate > '{d 2025-07-01}'&channel=email","description":"

Get a list of communication summaries with optional parameters. If a communication is archived and contact-level details are requested (i.e., including query or idaudience parameters), that communication is automatically excluded from the result. If those parameters are not specified, aggregated statistics remain available even for archived communications.

SQL-like query to filter newsletters (e.g. \"SELECT * FROM NEWSLETTERS WHERE sent=true and sentDate >= today(-7)\")

\n","type":"text/plain"},"key":"queryNewsletter","value":"SELECT * from NEWSLETTERS where template=0 AND sentdate > '{d 2025-07-01}'"},{"description":{"content":"

Channel to filter by (email, sms, fax, or a custom channel name)

\n","type":"text/plain"},"key":"channel","value":"email"},{"disabled":true,"description":{"content":"

MQL query to filter contacts

\n","type":"text/plain"},"key":"query","value":"select * from contacts where email like '%gmail.com'"},{"disabled":true,"description":{"content":"

ID of a contact's audience to filter by

\n","type":"text/plain"},"key":"idaudience","value":"1"},{"disabled":true,"description":{"content":"

Whether to calculate conversion goal statistics

\n","type":"text/plain"},"key":"conversiongoals","value":"true"}],"variable":[]}},"response":[{"id":"8f23fa20-26ef-46dd-a4a4-4e99a25b186a","name":"Get Newsletter summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/newsletters?queryNewsletter=SELECT * from NEWSLETTERS where template=0 AND sentdate > '{d 2025-07-01}'&channel=email","host":[""],"path":["v19","insights","newsletters"],"query":[{"key":"queryNewsletter","value":"SELECT * from NEWSLETTERS where template=0 AND sentdate > '{d 2025-07-01}'","description":"ID of the delivery to filter by","type":"text"},{"key":"channel","value":"email","description":"A/B split version: a or b (default a)","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 25 Jul 2025 07:48:39 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idnewsletter\": 370,\n \"channel\": \"email\",\n \"firstSentAt\": 1752763608300,\n \"lastSentAt\": 1752763608300,\n \"deliveryRate\": 100.0,\n \"bounceRate\": 0.0,\n \"openRate\": 100.0,\n \"clickToOpenRate\": 100.0,\n \"clickRate\": 100.0,\n \"conversionRate\": 0.0,\n \"clickPerClicked\": 300.0,\n \"conversionToClickRate\": 0.0,\n \"reachedRate\": 100.0,\n \"openersRate\": 100.0,\n \"clickersToOpenersRate\": 100.0,\n \"clickersRate\": 100.0,\n \"convertersRate\": 0.0,\n \"messagesSent\": 1,\n \"messagesReceived\": 1,\n \"messagesOpened\": 1,\n \"messagesUnreliableOpened\": 0,\n \"messagesClicked\": 1,\n \"messagesConverted\": 0,\n \"messagesWithUnsubscribeClicks\": 0,\n \"messagesWithSpamReports\": 0,\n \"messagesForwarded\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 0,\n \"recipients\": 1,\n \"reached\": 1,\n \"openers\": 1,\n \"unreliableOpeners\": 0,\n \"clickers\": 1,\n \"converters\": 0,\n \"unsubscribers\": 0,\n \"spamReporters\": 0,\n \"forwarders\": 0,\n \"totalOpens\": 3,\n \"totalUnreliableOpens\": 0,\n \"totalClicks\": 3,\n \"totalConversions\": 0,\n \"totalUnsubscribes\": 0,\n \"totalSpamReports\": 0,\n \"totalForwards\": 0,\n \"contents\": [\n {\n \"idcontent\": 1305,\n \"name\": \"Example.com\",\n \"clickers\": 1,\n \"totalClicks\": 1,\n \"messagesClicked\": 1,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0\n },\n {\n \"idcontent\": 1306,\n \"name\": \"Contact:CAMPO\",\n \"clickers\": 1,\n \"totalClicks\": 2,\n \"messagesClicked\": 1,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0\n }\n ],\n \"conversionGoalStats\": []\n }\n]"}],"_postman_id":"32f28189-8ea0-4900-86cb-ae74bd9a035d"},{"name":"Transactional summary","id":"b4d04415-b0d1-4da2-b828-715892250d29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/insights/transactional/:idnewsletter?conversiongoals=true&channels=email","description":"

Retrieves detailed insights and performance statistics for a specific transactional message. This endpoint provides delivery rates, engagement metrics (opens, clicks), and conversion data. It supports filtering by date range, specific contact criteria using a query, and specific communication channels.

The NaN value in rates, indicates that the rate cannot be computed because the denominator is zero.

The response is a JSON object containing:

idnewsletter: The unique identifier of the transactional message (template).
\n
channels: A set of active communication channels for this transactional message (e.g., email, sms).
\n
deliveryRate: The percentage of messages successfully delivered compared to the total sent.
\n
bounceRate: The percentage of messages that bounced (hard or soft).
\n
openRate: The percentage of delivered messages that were opened.
\n
clickToOpenRate: The percentage of unique openers who also clicked at least one link.
\n
clickRate: The percentage of delivered messages that resulted in at least one click.
\n
conversionRate: The percentage of delivered messages that resulted in a conversion.
\n
clickPerClicked: The average number of clicks per unique clicker.
\n
conversionToClickRate: The percentage of unique clickers who also converted.
\n
messagesSent: Total number of messages sent.
\n
messagesReceived: Total number of messages successfully delivered.
\n
messagesOpened: Number of unique messages opened.
\n
messagesUnreliableOpened: Number of messages with \"unreliable\" opens (e.g., detected via machine opens).
\n
messagesClicked: Number of unique messages that had at least one click.
\n
messagesConverted: Number of unique messages that resulted in a conversion.
\n
messagesWithUnsubscribeClicks: Number of unique messages that led to an unsubscribe click.
\n
messagesWithSpamReports: Number of unique messages that were reported as spam.
\n
messagesHardBounced: Total number of hard bounces.
\n
messagesSoftBounced: Total number of soft bounces.
\n
totalOpens: Total number of open events recorded.
\n
totalUnreliableOpens: Total number of unreliable open events recorded.
\n
totalClicks: Total number of click events recorded across all links.
\n
totalConversions: Total number of conversion events recorded.
\n
totalUnsubscribes: Total number of unsubscriptions.
\n
totalSpamReports: Total number of spam complaints.
\n
contents: A list of objects representing performance for each individual link in the message, each containing:
\n
- idcontent: Unique identifier of the content/link.
  \n
- name: Name or label of the link.
  \n
- url: The actual URL of the link.
  \n
- clickers: Number of unique contacts who clicked this link.
  \n
- totalClicks: Total number of clicks for this link.
  \n
- messagesClicked: Number of unique message instances where this link was clicked.
  \n
- converters: Number of unique contacts who converted after clicking this link.
  \n
- totalConversions: Total number of conversions attributed to this link.
  \n
- messagesConverted: Number of unique message instances where a conversion was attributed to this link.
  \n
\n
conversionGoalStats: A list of objects representing statistics for each conversion goal (included only if conversiongoals=true), each containing:
\n
- idgoal: Unique identifier of the conversion goal.
  \n
- goalName: The name of the goal.
  \n
- conversions: Number of conversions for this goal.
  \n
- conversionRate: The conversion rate for this specific goal.
  \n
- lastConversion: The timestamp of the last recorded conversion for this goal.
  \n
- totalValue: The total monetary or numerical value of all conversions for this goal.
  \n
- averageValue: The average value per conversion.
  \n
- currency: The currency associated with the goal values.
  \n
\n

An optional filter to restrict insights to sessions involving specific contacts. It accepts a filter expression (e.g., MQL - MagNews Query Language) to narrow down the statistics to a specific target audience.

\n","type":"text/plain"},"key":"query","value":"select * from contacts where email like '%gmail.com'"},{"disabled":true,"description":{"content":"

Optional. The start of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated from the beginning of the workflow's history.

\n","type":"text/plain"},"key":"from","value":"1704107890000"},{"disabled":true,"description":{"content":"

Optional. The end of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated up to the current moment.

\n","type":"text/plain"},"key":"to","value":"1769080690000"},{"description":{"content":"

Optional. If set to true, the response will include detailed statistics for conversion goals associated with the transactional message.

\n","type":"text/plain"},"key":"conversiongoals","value":"true"},{"description":{"content":"

Optional. A comma-separated list of channels to filter the statistics (e.g., email,sms).

\n","type":"text/plain"},"key":"channels","value":"email"}],"variable":[{"description":{"content":"

Required. Id of the transactional message for which insights are requested.

\n","type":"text/plain"},"type":"any","value":"230","key":"idnewsletter"}]}},"response":[{"id":"58e65af5-750c-4782-8a04-372ab7d6cd09","name":"Transactional summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/transactional/:idnewsletter?conversiongoals=true&channels=email","host":[""],"path":["v19","insights","transactional",":idnewsletter"],"query":[{"key":"query","value":"select * from contacts where email like '%gmail.com'","description":"An optional filter to restrict insights to sessions involving specific contacts. It accepts a filter expression (e.g., MQL - MagNews Query Language) to narrow down the statistics to a specific target audience.","type":"text","disabled":true},{"key":"from","value":"1704107890000","description":"Optional. The start of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated from the beginning of the workflow's history.","type":"text","disabled":true},{"key":"to","value":"1769080690000","description":"Optional. The end of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated up to the current moment.","type":"text","disabled":true},{"key":"conversiongoals","value":"true","description":"Optional. If set to true, the response will include detailed statistics for conversion goals associated with the transactional message."},{"key":"channels","value":"email","description":"Optional. A comma-separated list of channels to filter the statistics (e.g., email,sms)."}],"variable":[{"key":"idnewsletter","value":"512","description":"Required. Id of the transactional message for which insights are requested."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-MnPageType","value":"ws"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"mn1:2547"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Fri, 23 Jan 2026 08:06:08 GMT"},{"key":"Keep-Alive","value":"timeout=360"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=63072000;includeSubDomains"},{"key":"X-Proxy-Path","value":"wshttps_r;wshttps_a;wshttps_d;wshttps32"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"idnewsletter\": 512,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.82,\n \"bounceRate\": 0.18,\n \"openRate\": 21.45,\n \"clickToOpenRate\": 18.52,\n \"clickRate\": 3.97,\n \"conversionRate\": 1.22,\n \"clickPerClicked\": 138.4,\n \"conversionToClickRate\": 30.73,\n \"messagesSent\": 6250,\n \"messagesReceived\": 6239,\n \"messagesOpened\": 1338,\n \"messagesUnreliableOpened\": 1520,\n \"messagesClicked\": 248,\n \"messagesConverted\": 76,\n \"messagesWithUnsubscribeClicks\": 2,\n \"messagesWithSpamReports\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 11,\n \"totalOpens\": 2345,\n \"totalUnreliableOpens\": 4810,\n \"totalClicks\": 343,\n \"totalConversions\": 94,\n \"totalUnsubscribes\": 2,\n \"totalSpamReports\": 0,\n \"contents\": [\n {\n \"idcontent\": 2101,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 22,\n \"totalClicks\": 30,\n \"messagesClicked\": 22,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n },\n {\n \"idcontent\": 2102,\n \"name\": \"tiktok\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.tiktok.com/@example\"\n },\n {\n \"idcontent\": 2103,\n \"name\": \"https://shop.example.com/\",\n \"clickers\": 5,\n \"totalClicks\": 5,\n \"messagesClicked\": 5,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://shop.example.com/\"\n },\n {\n \"idcontent\": 3604,\n \"name\": \"Example Brand Made in Italy\",\n \"clickers\": 158,\n \"totalClicks\": 235,\n \"messagesClicked\": 164,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 3605,\n \"name\": \"Product Item Fashion Black\",\n \"clickers\": 61,\n \"totalClicks\": 71,\n \"messagesClicked\": 61,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n }\n ],\n \"conversionGoalStats\": [\n {\n \"idgoal\": 7,\n \"conversions\": 88,\n \"conversionRate\": 1.408,\n \"lastConversion\": 1769105250000,\n \"totalValue\": 9240.5,\n \"averageValue\": 105,\n \"goalName\": \"Purchase (S)\",\n \"currency\": \"€\"\n }\n ]\n}"}],"_postman_id":"b4d04415-b0d1-4da2-b828-715892250d29"},{"name":"Transactional summaries","id":"4a9bfddc-3720-4201-a973-c442ec01e536","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/insights/transactionals?queryTransactional=SELECT * from NEWSLETTERS where idworkflow = 3&channel=email","description":"

Retrieves a list of performance summaries for a batch of transactional messages (or workflow messages or message on site messages). This endpoint allows for bulk retrieval of transactional statistics, enabling performance comparison across multiple templates. It requires a query to select which transactional messages to include and supports filtering the statistics themselves by date range, specific contact criteria, and communication channels.

The response is a JSON array of transactional summary objects. (see /insight/transactional/:idnewsletter endpoint for details)

SQL-like query to filter transactionals

\n","type":"text/plain"},"key":"queryTransactional","value":"SELECT * from NEWSLETTERS where idworkflow = 3"},{"description":{"content":"

Channel to filter by (email, sms, fax, or a custom channel name)

\n","type":"text/plain"},"key":"channel","value":"email"},{"disabled":true,"description":{"content":"

MQL query to filter contacts

\n","type":"text/plain"},"key":"query","value":"select * from contacts where email like '%gmail.com'"},{"disabled":true,"description":{"content":"

Whether to calculate conversion goal statistics

\n","type":"text/plain"},"key":"conversiongoals","value":"true"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"from","value":"1704107890000"},{"disabled":true,"description":{"content":"

Optional. The end of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated up to the current moment.

\n","type":"text/plain"},"key":"to","value":"1769080690000"}],"variable":[]}},"response":[{"id":"8749e234-5430-4628-b071-894e304ef5bc","name":"Transactional summaries","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/transactionals?queryTransactional=SELECT * from NEWSLETTERS where idworkflow = 3&channel=email","host":[""],"path":["v19","insights","transactionals"],"query":[{"key":"queryTransactional","value":"SELECT * from NEWSLETTERS where idworkflow = 3","description":"SQL-like query to filter transactionals"},{"key":"channel","value":"email","description":"Channel to filter by (email, sms, fax, or a custom channel name)"},{"key":"query","value":"select * from contacts where email like '%gmail.com'","description":"MQL query to filter contacts","type":"text","disabled":true},{"key":"conversiongoals","value":"true","description":"Whether to calculate conversion goal statistics","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-MnPageType","value":"ws"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"mn1:2547"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Fri, 23 Jan 2026 08:36:10 GMT"},{"key":"Keep-Alive","value":"timeout=360"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=63072000;includeSubDomains"},{"key":"X-Proxy-Path","value":"wshttps_r;wshttps_a;wshttps_d;wshttps31"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"idnewsletter\": 412,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.72,\n \"bounceRate\": 0.28,\n \"openRate\": 25.10,\n \"clickToOpenRate\": 30.85,\n \"clickRate\": 7.74,\n \"conversionRate\": 7.22,\n \"clickPerClicked\": 142.15,\n \"conversionToClickRate\": 93.30,\n \"messagesSent\": 17200,\n \"messagesReceived\": 17152,\n \"messagesOpened\": 4305,\n \"messagesUnreliableOpened\": 3820,\n \"messagesClicked\": 1332,\n \"messagesConverted\": 1243,\n \"messagesWithUnsubscribeClicks\": 21,\n \"messagesWithSpamReports\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 48,\n \"totalOpens\": 8950,\n \"totalUnreliableOpens\": 14100,\n \"totalClicks\": 1894,\n \"totalConversions\": 2380,\n \"totalUnsubscribes\": 21,\n \"totalSpamReports\": 0,\n \"contents\": [\n {\n \"idcontent\": 3101,\n \"name\": \"Pantaloni Sport Fashion Pro Gray\",\n \"clickers\": 220,\n \"totalClicks\": 355,\n \"messagesClicked\": 225,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n },\n {\n \"idcontent\": 3102,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 30,\n \"totalClicks\": 45,\n \"messagesClicked\": 32,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n },\n {\n \"idcontent\": 3103,\n \"name\": \"Proceed to checkout\",\n \"clickers\": 915,\n \"totalClicks\": 1510,\n \"messagesClicked\": 965,\n \"converters\": 915,\n \"totalConversions\": 1510,\n \"messagesConverted\": 965,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 3104,\n \"name\": \"https://shop.example.com/\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://shop.example.com/\"\n },\n {\n \"idcontent\": 3105,\n \"name\": \"Privacy Policy\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/privacy-policy\"\n }\n ],\n \"conversionGoalStats\": []\n },\n {\n \"idnewsletter\": 528,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.48,\n \"bounceRate\": 0.52,\n \"openRate\": 18.25,\n \"clickToOpenRate\": 15.40,\n \"clickRate\": 2.81,\n \"conversionRate\": 2.15,\n \"clickPerClicked\": 158.20,\n \"conversionToClickRate\": 76.50,\n \"messagesSent\": 5100,\n \"messagesReceived\": 5073,\n \"messagesOpened\": 926,\n \"messagesUnreliableOpened\": 1180,\n \"messagesClicked\": 143,\n \"messagesConverted\": 109,\n \"messagesWithUnsubscribeClicks\": 5,\n \"messagesWithSpamReports\": 1,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 27,\n \"totalOpens\": 1580,\n \"totalUnreliableOpens\": 3650,\n \"totalClicks\": 226,\n \"totalConversions\": 182,\n \"totalUnsubscribes\": 5,\n \"totalSpamReports\": 1,\n \"contents\": [\n {\n \"idcontent\": 4125,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 5,\n \"totalClicks\": 6,\n \"messagesClicked\": 5,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n },\n {\n \"idcontent\": 4504,\n \"name\": \"Example Brand Made in Italy\",\n \"clickers\": 92,\n \"totalClicks\": 145,\n \"messagesClicked\": 95,\n \"converters\": 92,\n \"totalConversions\": 145,\n \"messagesConverted\": 95,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 4505,\n \"name\": \"Abbigliamento Fitness Green\",\n \"clickers\": 53,\n \"totalClicks\": 82,\n \"messagesClicked\": 53,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n }\n ],\n \"conversionGoalStats\": []\n },\n {\n \"idnewsletter\": 464,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.58,\n \"bounceRate\": 0.42,\n \"openRate\": 22.85,\n \"clickToOpenRate\": 21.90,\n \"clickRate\": 5.01,\n \"conversionRate\": 4.52,\n \"clickPerClicked\": 148.10,\n \"conversionToClickRate\": 90.20,\n \"messagesSent\": 6300,\n \"messagesReceived\": 6274,\n \"messagesOpened\": 1434,\n \"messagesUnreliableOpened\": 1350,\n \"messagesClicked\": 314,\n \"messagesConverted\": 285,\n \"messagesWithUnsubscribeClicks\": 15,\n \"messagesWithSpamReports\": 1,\n \"messagesHardBounced\": 2,\n \"messagesSoftBounced\": 24,\n \"totalOpens\": 2780,\n \"totalUnreliableOpens\": 4650,\n \"totalClicks\": 465,\n \"totalConversions\": 510,\n \"totalUnsubscribes\": 15,\n \"totalSpamReports\": 1,\n \"contents\": [\n {\n \"idcontent\": 5449,\n \"name\": \"Special Offer Example\",\n \"clickers\": 225,\n \"totalClicks\": 340,\n \"messagesClicked\": 230,\n \"converters\": 225,\n \"totalConversions\": 340,\n \"messagesConverted\": 230,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 5787,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 12,\n \"totalClicks\": 16,\n \"messagesClicked\": 12,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n },\n {\n \"idcontent\": 5769,\n \"name\": \"Fashion Top Black Edition\",\n \"clickers\": 68,\n \"totalClicks\": 109,\n \"messagesClicked\": 68,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n }\n ],\n \"conversionGoalStats\": []\n },\n {\n \"idnewsletter\": 531,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.81,\n \"bounceRate\": 0.19,\n \"openRate\": 20.15,\n \"clickToOpenRate\": 19.50,\n \"clickRate\": 3.93,\n \"conversionRate\": 1.18,\n \"clickPerClicked\": 140.80,\n \"conversionToClickRate\": 30.25,\n \"messagesSent\": 6100,\n \"messagesReceived\": 6088,\n \"messagesOpened\": 1227,\n \"messagesUnreliableOpened\": 1450,\n \"messagesClicked\": 239,\n \"messagesConverted\": 72,\n \"messagesWithUnsubscribeClicks\": 2,\n \"messagesWithSpamReports\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 12,\n \"totalOpens\": 2150,\n \"totalUnreliableOpens\": 4780,\n \"totalClicks\": 336,\n \"totalConversions\": 88,\n \"totalUnsubscribes\": 2,\n \"totalSpamReports\": 0,\n \"contents\": [\n {\n \"idcontent\": 6137,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 20,\n \"totalClicks\": 28,\n \"messagesClicked\": 20,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n },\n {\n \"idcontent\": 6140,\n \"name\": \"tiktok\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.tiktok.com/@example\"\n },\n {\n \"idcontent\": 6141,\n \"name\": \"https://shop.example.com/\",\n \"clickers\": 4,\n \"totalClicks\": 4,\n \"messagesClicked\": 4,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://shop.example.com/\"\n },\n {\n \"idcontent\": 6506,\n \"name\": \"Example Style Italy\",\n \"clickers\": 145,\n \"totalClicks\": 225,\n \"messagesClicked\": 150,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 6507,\n \"name\": \"Bolero Top Jacket Black\",\n \"clickers\": 55,\n \"totalClicks\": 82,\n \"messagesClicked\": 55,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n }\n ],\n \"conversionGoalStats\": []\n },\n {\n \"idnewsletter\": 347,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.30,\n \"bounceRate\": 0.70,\n \"openRate\": 27.10,\n \"clickToOpenRate\": 31.50,\n \"clickRate\": 8.54,\n \"conversionRate\": 7.85,\n \"clickPerClicked\": 130.50,\n \"conversionToClickRate\": 92.10,\n \"messagesSent\": 19500,\n \"messagesReceived\": 19363,\n \"messagesOpened\": 5247,\n \"messagesUnreliableOpened\": 4350,\n \"messagesClicked\": 1654,\n \"messagesConverted\": 1523,\n \"messagesWithUnsubscribeClicks\": 38,\n \"messagesWithSpamReports\": 0,\n \"messagesHardBounced\": 65,\n \"messagesSoftBounced\": 72,\n \"totalOpens\": 10850,\n \"totalUnreliableOpens\": 16200,\n \"totalClicks\": 2158,\n \"totalConversions\": 2850,\n \"totalUnsubscribes\": 39,\n \"totalSpamReports\": 0,\n \"contents\": [\n {\n \"idcontent\": 7689,\n \"name\": \"instagram\",\n \"clickers\": 3,\n \"totalClicks\": 4,\n \"messagesClicked\": 3,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.instagram.com/examplecosmetics/\"\n },\n {\n \"idcontent\": 7690,\n \"name\": \"tiktok\",\n \"clickers\": 2,\n \"totalClicks\": 3,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.tiktok.com/@example\"\n },\n {\n \"idcontent\": 7691,\n \"name\": \"https://shop.example.com/\",\n \"clickers\": 8,\n \"totalClicks\": 10,\n \"messagesClicked\": 8,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://shop.example.com/\"\n },\n {\n \"idcontent\": 7764,\n \"name\": \"Tuta Sportiva Pro Merlin\",\n \"clickers\": 225,\n \"totalClicks\": 390,\n \"messagesClicked\": 230,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n },\n {\n \"idcontent\": 7692,\n \"name\": \"Privacy Policy\",\n \"clickers\": 4,\n \"totalClicks\": 5,\n \"messagesClicked\": 4,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/privacy\"\n },\n {\n \"idcontent\": 7765,\n \"name\": \"Buy Now\",\n \"clickers\": 1012,\n \"totalClicks\": 1650,\n \"messagesClicked\": 1045,\n \"converters\": 1012,\n \"totalConversions\": 1650,\n \"messagesConverted\": 1045,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 7687,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 62,\n \"totalClicks\": 78,\n \"messagesClicked\": 62,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n }\n ],\n \"conversionGoalStats\": []\n },\n {\n \"idnewsletter\": 366,\n \"channels\": [\n \"email\"\n ],\n \"deliveryRate\": 99.88,\n \"bounceRate\": 0.12,\n \"openRate\": 23.10,\n \"clickToOpenRate\": 23.85,\n \"clickRate\": 5.51,\n \"conversionRate\": 4.90,\n \"clickPerClicked\": 138.50,\n \"conversionToClickRate\": 88.50,\n \"messagesSent\": 7800,\n \"messagesReceived\": 7791,\n \"messagesOpened\": 1800,\n \"messagesUnreliableOpened\": 1850,\n \"messagesClicked\": 430,\n \"messagesConverted\": 382,\n \"messagesWithUnsubscribeClicks\": 4,\n \"messagesWithSpamReports\": 0,\n \"messagesHardBounced\": 0,\n \"messagesSoftBounced\": 9,\n \"totalOpens\": 3250,\n \"totalUnreliableOpens\": 6400,\n \"totalClicks\": 595,\n \"totalConversions\": 680,\n \"totalUnsubscribes\": 4,\n \"totalSpamReports\": 0,\n \"contents\": [\n {\n \"idcontent\": 8804,\n \"name\": \"Privacy Policy\",\n \"clickers\": 2,\n \"totalClicks\": 2,\n \"messagesClicked\": 2,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/legal/privacy\"\n },\n {\n \"idcontent\": 8770,\n \"name\": \"Pantaloni Sport Magenta\",\n \"clickers\": 82,\n \"totalClicks\": 145,\n \"messagesClicked\": 82,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"[temp:item.link]\"\n },\n {\n \"idcontent\": 8771,\n \"name\": \"Buy Now\",\n \"clickers\": 275,\n \"totalClicks\": 420,\n \"messagesClicked\": 288,\n \"converters\": 275,\n \"totalConversions\": 420,\n \"messagesConverted\": 288,\n \"url\": \"[temp:checkout.checkouturl]\"\n },\n {\n \"idcontent\": 8799,\n \"name\": \"https://www.example.com/\",\n \"clickers\": 15,\n \"totalClicks\": 22,\n \"messagesClicked\": 15,\n \"converters\": 0,\n \"totalConversions\": 0,\n \"messagesConverted\": 0,\n \"url\": \"https://www.example.com/\"\n }\n ],\n \"conversionGoalStats\": []\n }\n]"}],"_postman_id":"4a9bfddc-3720-4201-a973-c442ec01e536"},{"name":"Workflow summary","id":"241b5cbc-df8c-4388-a003-c6dae15a2367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/insights/workflow/:idworkflow","description":"

Retrieves detailed insights and statistics for a specific workflow. This endpoint provides information such as total, active, and failed sessions, along with a breakdown of session exits by type and label. It supports filtering results by date range and by specific contact criteria using a query.

The response is a JSON array of WorkflowInsight objects. Each object contains:

idworkflow: The unique identifier of the workflow.
\n
idjourney: The ID of the journey (campaign) associated with the workflow.
\n
name: The name of the workflow.
\n
status: The current status of the workflow (e.g., \"active\", \"draft\", \"paused\").
\n
totalSessions: Total number of sessions started within the specified period and filters.
\n
activeSessions: Number of sessions currently in progress.
\n
errorSessions: Number of sessions that ended with an error status.
\n
firstSessionDate: Timestamp of the first session found in the results.
\n
lastSessionDate: Timestamp of the last session found in the results.
\n
sessionExits: A list of objects representing how sessions ended, each containing:
\n
- label: The label of the exit node in the workflow.
  \n
- exitType: The type of exit (positive, neutral, negative).
  \n
- count: The number of sessions that exited through this specific node.
  \n
\n

\n","type":"text/plain"},"key":"query","value":"select * from contacts"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"from","value":"1704107890000"},{"disabled":true,"description":{"content":"

Optional. The end of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds. If omitted, statistics will be calculated up to the current moment.

\n","type":"text/plain"},"key":"to","value":"1769080690000"}],"variable":[{"description":{"content":"

The unique identifier of the workflow for which insights are requested.

\n","type":"text/plain"},"type":"any","value":"7","key":"idworkflow"}]}},"response":[{"id":"938dd486-47a4-468f-be0d-d5354216221f","name":"Workflow summary","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/workflow/:idworkflow","host":[""],"path":["v19","insights","workflow",":idworkflow"],"query":[{"key":"query","value":"select * from contacts","description":"MQL query to filter contacts","type":"text","disabled":true},{"key":"from","value":"1704107890000","description":"timestamp in milliseconds","type":"text","disabled":true},{"key":"to","value":"1769080690000","type":"text","disabled":true}],"variable":[{"key":"idworkflow","value":"7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-MnPageType","value":"ws"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"mn1:2547"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Thu, 22 Jan 2026 11:25:11 GMT"},{"key":"Keep-Alive","value":"timeout=360"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=63072000;includeSubDomains"},{"key":"X-Proxy-Path","value":"wshttps_r;wshttps_a;wshttps_d;wshttps32"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"idworkflow\": 7,\n \"idjourney\": 5,\n \"name\": \"Recover Missing Orders\",\n \"status\": \"stopped\",\n \"totalSessions\": 10163,\n \"activeSessions\": 0,\n \"errorSessions\": 0,\n \"firstSessionDate\": 1732921200000,\n \"lastSessionDate\": 1734562800000,\n \"sessionExits\": [\n {\n \"label\": \"Recovered\",\n \"exitType\": \"positive\",\n \"count\": 10002\n },\n {\n \"label\": \"Clicked to recover\",\n \"exitType\": \"positive\",\n \"count\": 6\n },\n {\n \"label\": \"Exit without recovering\",\n \"exitType\": \"negative\",\n \"count\": 155\n }\n ]\n}"}],"_postman_id":"241b5cbc-df8c-4388-a003-c6dae15a2367"},{"name":"Workflow summaries","id":"c23004e6-a454-4523-a423-5448ca21086e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/insights/workflows?queryWorkflow=SELECT * FROM WORKFLOWS WHERE idcampaign = 123","description":"

Retrieves detailed insights and statistics for a batch of workflows. This endpoint allows for bulk retrieval of workflow performance data, including session counts (total, active, error) and session exit breakdowns. It supports filtering both the set of workflows to analyze and the specific contact sessions to include in the statistics, within a defined date range.

The response is a JSON array of workflow insigiths objects. (see /insight/workflow/:idworkflow endpoint for details)

MQL query to filter contacts

\n","type":"text/plain"},"key":"query","value":"select * from contacts where email like '%gmail.com'"},{"description":{"content":"

An optional SQL-like query string to filter the list of workflows for which insights are requested. If omitted, it defaults to SELECT * FROM WORKFLOWS. The results are limited to a maximum of 100 workflows per request.

\n","type":"text/plain"},"key":"queryWorkflow","value":"SELECT * FROM WORKFLOWS WHERE idcampaign = 123"},{"disabled":true,"description":{"content":"

Optional. The start of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds.

\n","type":"text/plain"},"key":"from","value":"1704107890000"},{"disabled":true,"description":{"content":"

Optional. The end of the time period for which insights should be calculated, expressed as a Unix timestamp in milliseconds.

\n","type":"text/plain"},"key":"to","value":"1769080690000"}],"variable":[]}},"response":[{"id":"d99fbfd1-9290-4a97-8973-991b57d59a1c","name":"Workflow summaries","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/insights/workflows?queryWorkflow=SELECT * FROM WORKFLOWS WHERE idcampaign = 1","host":[""],"path":["v19","insights","workflows"],"query":[{"key":"queryWorkflow","value":"SELECT * FROM WORKFLOWS WHERE idcampaign = 1","description":"An optional filter to restrict insights to sessions involving specific contacts. It accepts a filter expression (e.g., MQL - MagNews Query Language) to narrow down the statistics to a specific target audience. |","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Thu, 22 Jan 2026 14:06:09 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"idworkflow\": 11,\n \"idjourney\": 7,\n \"name\": \"shopify\",\n \"status\": \"active\",\n \"totalSessions\": 0,\n \"activeSessions\": 0,\n \"errorSessions\": 0,\n \"firstSessionDate\": null,\n \"lastSessionDate\": null,\n \"sessionExits\": [\n {\n \"label\": \"Default Exit\",\n \"exitType\": \"neutral\",\n \"count\": 0\n }\n ]\n },\n {\n \"idworkflow\": 16,\n \"idjourney\": 1,\n \"name\": \"dynamics\",\n \"status\": \"active\",\n \"totalSessions\": 76,\n \"activeSessions\": 2,\n \"errorSessions\": 0,\n \"firstSessionDate\": 1665439200000,\n \"lastSessionDate\": 1689026400000,\n \"sessionExits\": [\n {\n \"label\": \"Success\",\n \"exitType\": \"positive\",\n \"count\": 74\n }\n ]\n },\n {\n \"idworkflow\": 33,\n \"idjourney\": 10,\n \"name\": \"Recover abandoned carts\",\n \"status\": \"draft\",\n \"totalSessions\": 0,\n \"activeSessions\": 0,\n \"errorSessions\": 0,\n \"firstSessionDate\": null,\n \"lastSessionDate\": null,\n \"sessionExits\": [\n {\n \"label\": \"Purchase\",\n \"exitType\": \"positive\",\n \"count\": 0\n },\n {\n \"label\": \"No purchase\",\n \"exitType\": \"negative\",\n \"count\": 0\n }\n ]\n }\n]"}],"_postman_id":"c23004e6-a454-4523-a423-5448ca21086e"}],"id":"f2a7ca37-d772-41fe-99ca-72b4f5c296da","_postman_id":"f2a7ca37-d772-41fe-99ca-72b4f5c296da","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Scheduled Works","item":[{"name":"Find scheduled work by id","id":"61a01cb0-21d0-4e46-9f32-72f813c8d3cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/scheduledworks/:idoperation","description":"

Find a scheduled work by ID

Trigger a scheduled work by ID with optional delay.

Optional delay in minutes

\n","type":"text/plain"},"key":"delay","value":":delay"}],"variable":[{"id":"34a6c6e2-040b-43b8-88ef-ee3cf33ef7f0","type":"any","key":"idoperation"}]}},"response":[{"id":"a8e93873-de24-477a-82a5-a1c575126ba4","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/scheduledworks/:idoperation/trigger?delay=5","host":[""],"path":["v19","scheduledworks",":idoperation","trigger"],"query":[{"key":"delay","value":"5","description":"Optional delay in minutes"}],"variable":[{"key":"idoperation","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"idoperation\": 1,\n \"name\": \"Daily Newsletter\",\n \"status\": \"triggered\",\n \"executionTime\": \"2023-06-20T10:35:00.000Z\",\n \"message\": \"Operation successfully triggered with 5 minutes delay\",\n \"executionId\": \"exec-123456\"\n}"}],"_postman_id":"9931ddc7-5a19-4bf8-8ea9-52dc00d5777d"}],"id":"d274f6af-6bb4-4ce7-a787-9814c548792f","description":"

This section describes the available REST API functions for retrieving data related to scheduled operations (called \"Scheduled tasks\" in magnews platform).

\n","_postman_id":"d274f6af-6bb4-4ce7-a787-9814c548792f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Export","item":[{"name":"Bulk download (get)","id":"c8146751-9d1d-487d-bc82-1f47f9934f7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/export/bulkdownload?query=SELECT * FROM CONTACTS LIMIT 100&lineSeparator=\\n"ationMark=\"&encoding=UTF-8&fieldSeparator=,","description":"

Download data using a MQL query (GET method).

See the Query documentation for more details on how to write queries.

Optional line separator

\n","type":"text/plain"},"key":"lineSeparator","value":"\\n"},{"description":{"content":"

Optional quotation mark

\n","type":"text/plain"},"key":"quotationMark","value":"\""},{"description":{"content":"

Optional encoding

\n","type":"text/plain"},"key":"encoding","value":"UTF-8"},{"description":{"content":"

Optional field separator

\n","type":"text/plain"},"key":"fieldSeparator","value":","}],"variable":[]}},"response":[{"id":"d0f1fa78-9d28-40bd-9106-5b4096737dfc","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/export/bulkdownload?query=SELECT * FROM CONTACTS LIMIT 2","host":[""],"path":["v19","export","bulkdownload"],"query":[{"key":"query","value":"SELECT * FROM CONTACTS LIMIT 2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/csv"},{"key":"Content-Disposition","value":"attachment; filename=export.csv"}],"cookie":[],"responseTime":null,"body":"idcontact,email,name,surname,company,phone,status\n1,\"contact@example.com\",\"John\",\"Doe\",\"Example Corp\",\"+1234567890\",\"active\"\n2,\"contact2@example.com\",\"Jane\",\"Doe\",\"Example Inc\",\"+1987654321\",\"active\""}],"_postman_id":"c8146751-9d1d-487d-bc82-1f47f9934f7b"},{"name":"Bulk download (post)","id":"77aefaa4-d568-4ed5-bea4-56956ad5b49a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"SELECT * FROM CONTACTS LIMIT 100\",\n \"options\": {\n \"lineSeparator\": \"\\n\",\n \"quotationMark\": \"\\\"\",\n \"encoding\": \"UTF-8\",\n \"fieldSeparator\": \",\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/export/bulkdownload","description":"

Download data using a MQL query (POST method)

See the Query documentation for more details on how to write queries.

Using the Bulk Export API

If you need to export data from custom or system tables, use this API.

This endpoint executes a full query and returns the complete result set.
There is no pagination, but the result is streamed efficiently.

The response is encoded in CSV format with the following default settings:

Encoding: UTF-8
\n
Field separator: ;
\n
No field delimiter
\n
Line separator: Windows (\\r\\n)
\n

You can customize these options via query parameters in the request body (see the examples requests for both POST and GET modes).

Writing queries

See the Query documentation for more details.

\n","_postman_id":"4f368318-49df-4b17-97b9-1868c42d6b5e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Entities","item":[{"name":"Find entity","id":"0b2659d2-485a-4e44-9216-3e96f7c33ef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/entities/:entityName/data","description":"

Find an entity by name

Result: Returns an existing record.

The lookup is performed using the fields provided in the POST body, typically the table primary key or the user-defined primary key fields.

In this example sku is the logical key of the entity

\n","type":"text/plain"},"key":"sku","value":""}],"variable":[{"type":"any","value":"products","key":"entityName"}]}},"response":[{"id":"0a269590-d34c-478a-af4d-c85249e2306a","name":"Success Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v19/entities/:entityName/data?sku=MP11-33-Brown","host":[""],"path":["v19","entities",":entityName","data"],"query":[{"key":"sku","value":"MP11-33-Brown"}],"variable":[{"key":"entityName","value":"products"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entityName\": \"products\",\n \"fields\": [\n {\n \"name\": \"id\",\n \"type\": \"integer\",\n \"isPrimaryKey\": true\n },\n {\n \"name\": \"name\",\n \"type\": \"string\",\n \"maxLength\": 100\n },\n {\n \"name\": \"description\",\n \"type\": \"string\",\n \"maxLength\": 500\n },\n {\n \"name\": \"price\",\n \"type\": \"decimal\",\n \"precision\": 10,\n \"scale\": 2\n },\n {\n \"name\": \"category\",\n \"type\": \"string\",\n \"maxLength\": 50\n },\n {\n \"name\": \"creationDate\",\n \"type\": \"datetime\"\n }\n ],\n \"totalRecords\": 120,\n \"lastModifiedDate\": \"2023-06-15T10:30:00.000Z\"\n}"}],"_postman_id":"0b2659d2-485a-4e44-9216-3e96f7c33ef5"},{"name":"Merge entity","id":"56443aec-263e-42b1-9023-54d5b6cb04ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": {\n \"id\": 1,\n \"updated_at\": \"25/05/2025 00:00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/entities/:entityName/data","description":"

Insert or update a record in an entity table

Post body options

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Option	Type	Default Value	Description
`operationtype`	String	`upsert`	Type of operation to perform. Possible values are: `update`, `insert` or `upsert`.

Post body fields format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Column data type	Entity field type	Example	Description
Text / Long text		`\"my string value\"`	Double quoted string
Integer (1 byte)	Integer	`1`	Integer number
Integer (1 byte)	Checkbox	`true`	Boolean value: `true` or `false`
Integer (4 or 8 bytes)		`10`	Integer or long number
Decimal number		`\"10.5\"` or `\"10,5\"`	Quoted string formatted according to current user's international settings
Date		`\"24/06/2017\"`	Quoted string formatted according to date format and time zone settings
Date and time		`\"24/06/2017 10:17\"`	Quoted string formatted

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}},"urlObject":{"path":["v19","entities",":entityName","data"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"entityName"}]}},"response":[{"id":"34b96ada-6f6b-4f0d-bea9-266600703ccc","name":"Success Upsert entity","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fields\": {\n \"id\": 1,\n \"updated_at\": \"25/05/2025 00:00\"\n }\n}"},"url":{"raw":"/v19/entities/:entityName/data","host":[""],"path":["v19","entities",":entityName","data"],"variable":[{"key":"entityName","value":"mage_order_items"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 24 Apr 2025 16:46:04 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"primarykey\": {\n \"id\": 1\n },\n \"fields\": {\n \"tax_amount\": 0,\n \"item_discount_amount\": 0,\n \"item_tax_amount\": 0,\n \"discount_amount\": 0,\n \"created_at\": \"14/05/2024 15:59\",\n \"qty_ordered\": 2,\n \"total_item_count\": 0,\n \"tax_percent\": 0,\n \"updated_at\": \"25/05/2025 00:00\",\n \"price_incl_tax\": 0,\n \"price\": 74,\n \"product_id\": 859,\n \"grand_total\": 158,\n \"id\": 1,\n \"idcontact\": 500595,\n \"state\": \"complete\",\n \"sku\": \"MP11-33-Brown\",\n \"store_id\": 1,\n \"coupon_code\": null,\n \"item_id\": 6,\n \"quote_id\": 5,\n \"entity_id\": 4,\n \"shipping_amount\": 10,\n \"subtotal\": 148,\n \"name\": \"Aether Gym Pant -33-Brown\",\n \"customer_id\": 2,\n \"order_currency_code\": \"USD\",\n \"status\": \"complete\"\n }\n}"}],"_postman_id":"56443aec-263e-42b1-9023-54d5b6cb04ee"},{"name":"Batch merge entity","id":"a2b50f35-bd8f-42af-a688-7943b2311b9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"options\":{\n \"operationtype\":\"upsert\",\n \"fulldump\":false\n },\n \"entities\":[\n {\n \"primarykey\": {\n \"myautoincprimarykey\":1\n },\n \"fields\": {\n \"myuserprimarykey\": 1234,\n \"mystringfield\": \"hello\",\n \"myint\": 1,\n \"mynumber\": 10.05,\n \"mybool\": true,\n \"mydatetime\": \"24/06/2021 10:05\",\n \"mydate\": \"24/06/2021\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v19/entities/:entityName/batchdata","description":"

Create or update user entity instances from batch

An entity is a custom data table defined as User Entity on magnews.

\n
Note: In the :entityName parameter, use the name of the user entity, not the name of the underlying data table.
\n

\n","_postman_id":"e2e1001e-06a8-47be-bea9-60754667b03f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Account","item":[{"name":"Get residual credit","id":"eaaaa79e-6097-4ab6-899e-c35a3b5f2c53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19/account/residualcredit/:channel","description":"

Get the available credit for a channel (email or sms)

Allowed values for channel: email, sms.

Result: A number representing the residual credit.

If credit is 1000, it returns a value approximated to the nearest thousand, rounding down.
\n
If credit is 0 or negative, it returns 0.
\n
For accounts with a flat plan, it returns residual credit plus automatic credit.
\n
For accounts with a final balance plan, it always returns -1.
\n

Get relevant information about the user profile associated with the current token and its account.

Execute an MQL select query. For update/insert/delete queries, use Execute MQL update endpoint.

Writing queries

See the Query documentation for more details on how to write queries.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}},"urlObject":{"path":["v19","mql","execute"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"553fdb81-2ef6-4739-99c2-a17c210f7c2f","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select * from contacts limit 10\",\n \"options\": {\n \"max\": \"10\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 24 Apr 2025 16:49:22 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 10,\n \"columnNames\": [\n \"idcontact\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"2\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"3\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"4\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"5\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"6\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"37\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"38\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"68\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"69\"\n }\n ]\n }\n ]\n}"},{"id":"c526e9be-3d77-451b-9a1f-7bf6c6987e0f","name":"Bad query error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select * from contacts limit\",\n \"options\": {\n \"max\": \"10\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/mql/execute"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 24 Apr 2025 16:49:22 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Internal Server Error\",\n \"debugMessage\": \"bad query select * from contacts limit, parser error is: Encountered unexpected token:\\n at line 1, column 28.\\n\\nWas expecting one of:\\n\\n \\\":\\\"\\n \\\"?\\\"\\n \\\"ALL\\\"\\n \\\"NULL\\\"\\n \\n.\"\n}"},{"id":"7ec1d94d-95de-49bf-b6f2-86a6d07ebe41","name":"Query static audience members","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select * from staticgroupmembers where idgroup=23\",\n \"options\": {\n \"max\": \"10\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 31 Oct 2025 08:19:13 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 8,\n \"columnNames\": [\n \"idcontact\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"33\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"34\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"35\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"482470\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"482471\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"542425\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"542437\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"542438\"\n }\n ]\n }\n ]\n}"},{"id":"5dbd3996-90aa-48b5-950f-a4949c31d1f1","name":"Query audiences","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select idgroup,name,creationdate,lastmodificationdate from groups\",\n \"options\": {\n \"max\": \"10\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 31 Oct 2025 08:47:56 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 10,\n \"columnNames\": [\n \"idgroup\",\n \"name\",\n \"creationdate\",\n \"lastmodificationdate\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"1\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,suspended%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"2\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,unsubscribed%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"3\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,waiting%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"4\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,all%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"5\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,suspended%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"6\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,unsubscribed%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"7\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,waiting%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"8\"\n },\n {\n \"key\": \"name\",\n \"value\": \"%%dbreaders,all%%\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"02/09/2020 11:47\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"9\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Iscritti alla newsletter\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"25/09/2018 08:16\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"25/09/2018 08:16\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idgroup\",\n \"value\": \"10\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Iscritti alla newsletter - Clienti\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"25/09/2018 08:16\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"25/09/2018 08:16\"\n }\n ]\n }\n ]\n}"},{"id":"90094560-b117-411c-8145-5bd95cb9e65d","name":"Query workflows","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select idworkflow, name, creationdate, idcampaign from workflows where idcampaign in (1,2)\",\n \"options\": {\n \"max\": \"10\"\n }\n}"},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 12 Nov 2025 13:45:20 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 10,\n \"columnNames\": [\n \"idworkflow\",\n \"name\",\n \"creationdate\",\n \"idcampaign\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"1\"\n },\n {\n \"key\": \"name\",\n \"value\": \"magneto\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"16/10/2015 08:25\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"5\"\n },\n {\n \"key\": \"name\",\n \"value\": \"dynamics\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"17/05/2019 11:36\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"15\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Magento Test Workflow\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"26/07/2022 11:22\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"16\"\n },\n {\n \"key\": \"name\",\n \"value\": \"dynamics\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"11/10/2022 09:50\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"19\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Prova LinkedIn Stefic\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"25/01/2023 09:16\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"20\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Prova 2 LinkedIn Stefic\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"25/01/2023 11:10\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"21\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Shopify stefic\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"17/03/2023 09:15\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"24\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Prova stefic\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"17/04/2023 14:48\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"25\"\n },\n {\n \"key\": \"name\",\n \"value\": \"prova aggiorna contatto\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"17/04/2023 15:33\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idworkflow\",\n \"value\": \"29\"\n },\n {\n \"key\": \"name\",\n \"value\": \"New automated flow\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"26/09/2023 14:41\"\n },\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n }\n ]\n }\n ]\n}"},{"id":"85a6b727-f227-4c2c-9692-4d39dc0c3648","name":"Query journeys","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select idcampaign, name, status, creationdate, lastmodificationdate from campaigns where name like '%my%'\",\n \"options\": {\n \"max\": \"10\"\n }\n}"},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 12 Nov 2025 13:59:10 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 2,\n \"columnNames\": [\n \"idcampaign\",\n \"name\",\n \"status\",\n \"creationdate\",\n \"lastmodificationdate\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idcampaign\",\n \"value\": \"1\"\n },\n {\n \"key\": \"name\",\n \"value\": \"My Campaign\"\n },\n {\n \"key\": \"status\",\n \"value\": \"active\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"10/07/2015 12:38\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcampaign\",\n \"value\": \"4\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Sito web | My Web Site\"\n },\n {\n \"key\": \"status\",\n \"value\": \"active\"\n },\n {\n \"key\": \"creationdate\",\n \"value\": \"10/07/2015 12:38\"\n },\n {\n \"key\": \"lastmodificationdate\",\n \"value\": \"10/07/2015 12:38\"\n }\n ]\n }\n ]\n}"},{"id":"d78431b0-a1a1-4803-a5bf-32279d54954f","name":"Query workflow messages","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select idnewsletter, name, template, subject, idworkflow from newsletters where idworkflow=1\",\n \"options\": {\n \"max\": \"10\"\n }\n}"},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:9"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 13 Nov 2025 15:00:08 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 2,\n \"columnNames\": [\n \"idnewsletter\",\n \"name\",\n \"template\",\n \"subject\",\n \"idworkflow\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idnewsletter\",\n \"value\": \"24\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Nuovo workflow #1 (email)\"\n },\n {\n \"key\": \"template\",\n \"value\": \"true\"\n },\n {\n \"key\": \"subject\",\n \"value\": \"\"\n },\n {\n \"key\": \"idworkflow\",\n \"value\": \"1\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idnewsletter\",\n \"value\": \"26\"\n },\n {\n \"key\": \"name\",\n \"value\": \"Nuovo workflow #2 (email)\"\n },\n {\n \"key\": \"template\",\n \"value\": \"true\"\n },\n {\n \"key\": \"subject\",\n \"value\": \"\"\n },\n {\n \"key\": \"idworkflow\",\n \"value\": \"1\"\n }\n ]\n }\n ]\n}"},{"id":"243c2588-1878-4d77-ac3f-bfa780af5d86","name":"Query deliveries","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select iddelivery, idnewsletter, startdate, emailchannelenabled, smschannelenabled, status, emailmessages, smsmessages, scheduletype, trial from deliveries\",\n \"options\": {\n \"max\": \"10\"\n }\n}"},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 23 Jan 2026 11:18:53 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 10,\n \"columnNames\": [\n \"iddelivery\",\n \"idnewsletter\",\n \"startdate\",\n \"emailchannelenabled\",\n \"smschannelenabled\",\n \"status\",\n \"emailmessages\",\n \"smsmessages\",\n \"scheduletype\",\n \"trial\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"2\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"5\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"02/23/2017 13:13\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"3\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"6\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"02/23/2017 13:54\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"4\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"7\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"01/11/2018 09:28\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"5\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"8\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"02/06/2018 12:01\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"6\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"19\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"05/17/2019 12:25\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"3\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"7\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"25\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"06/20/2019 10:25\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"2\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"9\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"34\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"06/26/2019 14:16\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"true\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"10\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"34\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"06/26/2019 15:16\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"true\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"11\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"34\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"06/26/2019 15:45\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"2\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"iddelivery\",\n \"value\": \"12\"\n },\n {\n \"key\": \"idnewsletter\",\n \"value\": \"77\"\n },\n {\n \"key\": \"startdate\",\n \"value\": \"11/26/2019 12:16\"\n },\n {\n \"key\": \"emailchannelenabled\",\n \"value\": \"true\"\n },\n {\n \"key\": \"smschannelenabled\",\n \"value\": \"false\"\n },\n {\n \"key\": \"status\",\n \"value\": \"finished\"\n },\n {\n \"key\": \"emailmessages\",\n \"value\": \"1\"\n },\n {\n \"key\": \"smsmessages\",\n \"value\": \"0\"\n },\n {\n \"key\": \"scheduletype\",\n \"value\": \"single\"\n },\n {\n \"key\": \"trial\",\n \"value\": \"false\"\n }\n ]\n }\n ]\n}"},{"id":"4b14e8ad-ca2e-494b-b0c7-ab66c82527a4","name":"Execute MQL select (with query parameters)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"select idcontact, email, data_ultima_modifica from contacts where data_ultima_modifica > ? and email like ?\",\n \"options\": {\n \"max\": \"10\"\n },\n \"parameters\": [\"15/07/2024 09:45\", \"%@example.com%\"]\n}"},"url":"/v19/mql/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Date","value":"Wed, 28 Jan 2026 12:13:36 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"recordCount\": 10,\n \"columnNames\": [\n \"idcontact\",\n \"email\",\n \"data_ultima_modifica\"\n ],\n \"records\": [\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"2\"\n },\n {\n \"key\": \"email\",\n \"value\": \"anagramma@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"4\"\n },\n {\n \"key\": \"email\",\n \"value\": \"roni_cost@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"5\"\n },\n {\n \"key\": \"email\",\n \"value\": \"subscriber1@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"17\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel1@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"18\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel2@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"19\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel3@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"20\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel4@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"21\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel5@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"22\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel6@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n },\n {\n \"record\": [\n {\n \"key\": \"idcontact\",\n \"value\": \"23\"\n },\n {\n \"key\": \"email\",\n \"value\": \"someonel7@example.com\"\n },\n {\n \"key\": \"data_ultima_modifica\",\n \"value\": \"11/18/2025 12:53\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"06620008-accc-4f76-a4d0-dbee3e9b77f3"},{"name":"Execute MQL update/insert/delete","id":"3459ef65-c64e-47a8-bf73-de429630c4fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"query\": \"update orders set order_shipped=? where id=?\",\n \"parameters\": [\"true\", 13]\n}","options":{"raw":{"language":"json"}}},"url":"/v19/mql/update","description":"

Execute an MQL update query (update/insert/delete). For select queries use Execute MQL query endpoint.
⚠️ Update, insert and delete operations can only be performed on custom entities, not on system entities such as contacts or newsletters.

Magnews Query Language is a meta sql language used to query system and custom table of a magnews account.

See the Query documentation for more details on how to write queries.

\n","_postman_id":"bccae735-eda4-48e6-8261-4c9d199650dc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Create webhook","id":"d013e3cf-84d4-4e12-a117-c4dee2ae3d45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"uri\": \"https://www.example.com/mywebhook_handler\",\n \"topics\": \"contacts/update,contacts/delete\"\n}\n","options":{"raw":{"language":"json"}}},"url":"/v19/webhooks/create","description":"

Registers a new webhook to receive magnews events in near real-time.

A webhook can be registered only if the URI provided meets these requirements:

HTTPS with a valid certificate (TLS with a non-expired, non-self-signed certificate issued by a trusted CA)
\n
URI compliant with RFC 2396
\n
The endpoint must return HTTP 200 quickly (timeout: connection 1s, read 5s). Any other status code is treated as an error.
\n
Successful initial verification: before creating the subscription, magnews sends a test request to verify the endpoint.
\n

Update a webhook subscription (uri, status, topics)

Find a Webhook Subscription given its ID

List all Webhook Subscriptions

Deletes a Webhook Subscription given its ID

id of the webhook subscription

\n","type":"text/plain"},"type":"any","value":"3","key":"id"}]}},"response":[{"id":"f7dc9761-906f-412b-8aeb-a9a7634d3956","name":"Success response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/v19/webhooks/delete/:id","host":[""],"path":["v19","webhooks","delete",":id"],"variable":[{"key":"id","value":"3","description":"id of the webhook subscription"}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"X-Mn-PageType","value":"Webservice"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"origin, content-type, accept, authorization"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, OPTIONS"},{"key":"X-MN-ENV","value":"qapatch:6"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"X-Frame-Options","value":"Deny"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"default-src 'self'; frame-ancestors 'self'; report-uri https://csp-reporting.mag-news.it"},{"key":"Date","value":"Fri, 14 Nov 2025 13:14:03 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"},{"key":"X-Proxy-Path","value":"hq_qapatch_route_https;hq_qapatch_action_https;hq_qapatch_director_https;hq_qapatch_tomcat_https"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"89661252-0177-4453-9c13-2e20eee4beb0"}],"id":"a69dbe7d-9521-4c91-bc1b-b036bbe4e4d7","description":"

Webhooks allow external systems to receive events from magnews in near real-time.

An external application must expose an HTTPS URL capable of receiving POST requests: for each event generated, magnews will send a request to that endpoint with the event data.

\n","_postman_id":"a69dbe7d-9521-4c91-bc1b-b036bbe4e4d7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c41301cc-4697-4aad-a300-3dff8accc11f","id":"c41301cc-4697-4aad-a300-3dff8accc11f","name":"Magnews REST API","type":"collection"}}},{"name":"System","item":[{"name":"Get api version","id":"4f5a25df-291a-4539-985d-74f59b6d4947","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v19","description":"

Returns the API version