Get Preview Mailing
Get a shipment message from its shipment address id
NsApiSlow threshold: 5000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Body
ShipmentAddrId
GetPreviewMailing: Get a shipment message from its shipment address id
Response
OK
A shipment message with information about the recipient it was sent to. Carrier object for PreviewMailing. Services for the PreviewMailing Carrier is available from the Marketing Agent.
Estimated or actual sent time (depends on status)
Status for sending to this particular recipient
Unknown, Ready, Duplicate, Blocked, Sent, Bounced, Opened, Clicked, SoftBounced, NoSubscription, Complained, TooManyBounces, TestMail Primary key
Describes the shipment
Email address to put in the From header of the messages
This field indicates what kind of shipment this is.
Owning contact ID
Contact name
Primary key
Get the persons full name (internal name used in clients for employees).
The list item
Primary key
The mail subject field of the message
If a document was used as the message this is the document ID.
Date/time the customer read the mailing.
The number of links clicked in the mailing.
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
Get Preview Mailing HeaderNSMarketingAgentNSPreviewMailingNSPreviewMailingHeaderTutorial - document mailingTutorial - email mailing