Get Preview Mailing Header
Get a shipment from its shipment 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
ShipmentId
GetPreviewMailingHeader: Get a shipment from its shipment id
Response
OK
A shipment with information intended for previewing it. Carrier object for PreviewMailingHeader. Services for the PreviewMailingHeader Carrier is available from the Marketing Agent.
The date and time when to start this shipment
Sending/stopped/failed etc.
None, Ok, Canceled, Waiting, Started, StatusFailed, Retry, Populating, Deleted, AwaitPopulate, PopulatingOnly, PopulateAborted, PopulateError, TooManyRecipients 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.
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.
Number of emails sent at the current time.
Number of recipients that opened the email.
Number of recipients that resulted in a bounce.
Number of recipients that clicked at least 1 link 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
NSMarketingAgentNSPreviewMailingHeaderGet Preview MailingNSPreviewMailingGet PreviewTutorial - document mailing