Get Mailing Entity
Gets a MailingEntity object.
Calls the Marketing agent service GetMailingEntity. 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.
Path Parameters
The id of the MailingEntity to return.
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.
Response
MailingEntity found.
A mailing (shipment) — the run that sends a message to a set of recipients MailingEntity entity with API _Links added.
Primary key
Describes the shipment
The id of the message that is sent in this shipment
The folder which this shipment belongs to. -1 indicates that the shipment is on the root
The date and time when to start this shipment
Is set when this shipment is ended
Email address to put in the From header of the messages
Email address to put in the Reply To: header of the messages
Email address for the MTA envelope (where bounces are returned)
Sending/stopped/failed etc.
None, Ok, Canceled, Waiting, Started, StatusFailed, Retry, Populating, Deleted, AwaitPopulate, PopulatingOnly, PopulateAborted, PopulateError, TooManyRecipients The total number of recipients to send message to.
This field indicates what kind of shipment this is.
Set if this shipment should be related to a Selection
Set if this shipment should be related to a Project
Id of subscriptionType that this shipment has, so we may check for reservations
Number of mails sent
Number of mails sent minus bounces
Registered when in UTC.
Registered by whom
Last updated when in UTC.
Last updated by whom
Number of updates made to this record
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 Mailing EntityDelete Mailing EntityPost Mailing EntityDefault Mailing EntityPut Mailing Entity