Skip to main content
Get Mailing Entity

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.

Path Parameters

id
integer<int32>
required

The id of the MailingEntity to return.

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.

Response

MailingEntity found.

A mailing (shipment) — the run that sends a message to a set of recipients MailingEntity entity with API _Links added.

MailingId
integer<int32>

Primary key

Description
string

Describes the shipment

MessageId
integer<int32>

The id of the message that is sent in this shipment

FolderId
integer<int32>

The folder which this shipment belongs to. -1 indicates that the shipment is on the root

StartDate
string<date-time>

The date and time when to start this shipment

EndDate
string<date-time>

Is set when this shipment is ended

FromAddr
string

Email address to put in the From header of the messages

ReplyAddr
string

Email address to put in the Reply To: header of the messages

EnvelopeFrom
string

Email address for the MTA envelope (where bounces are returned)

Status
enum<string>

Sending/stopped/failed etc.

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

The total number of recipients to send message to.

Configuration
integer<int32>

This field indicates what kind of shipment this is.

SelectionId
integer<int32>

Set if this shipment should be related to a Selection

ProjectId
integer<int32>

Set if this shipment should be related to a Project

ShipmenttypeId
integer<int32>

Id of subscriptionType that this shipment has, so we may check for reservations

SentNum
integer<int32>

Number of mails sent

DeliveredNum
integer<int32>

Number of mails sent minus bounces

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

UpdatedCount
integer<int32>

Number of updates made to this record

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.