Skip to main content
Get Preview Mailing Header

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

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

ShipmentId
integer<int32>

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.

StartDate
string<date-time>

The date and time when to start this shipment

Status
enum<string>

Sending/stopped/failed etc.

Available options:
None,
Ok,
Canceled,
Waiting,
Started,
StatusFailed,
Retry,
Populating,
Deleted,
AwaitPopulate,
PopulatingOnly,
PopulateAborted,
PopulateError,
TooManyRecipients
ShipmentId
integer<int32>

Primary key

ShipmentDescription
string

Describes the shipment

FromAddress
string

Email address to put in the From header of the messages

Configuration
integer<int32>

This field indicates what kind of shipment this is.

PersonId
integer<int32>

Primary key

PersonFullName
string

Get the persons full name (internal name used in clients for employees).

ShipmentType
string

The list item

MessageId
integer<int32>

Primary key

MessageSubject
string

The mail subject field of the message

DocumentMessageId
integer<int32>

If a document was used as the message this is the document ID.

NumSent
integer<int32>

Number of emails sent at the current time.

NumOpened
integer<int32>

Number of recipients that opened the email.

NumBounced
integer<int32>

Number of recipients that resulted in a bounce.

NumClicks
integer<int32>

Number of recipients that clicked at least 1 link in the mailing.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.