Save Mailing Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"MailingId\": 123,\n  \"Description\": \"<string>\",\n  \"MessageId\": 123,\n  \"FolderId\": 123,\n  \"StartDate\": \"2023-11-07T05:31:56Z\",\n  \"EndDate\": \"2023-11-07T05:31:56Z\",\n  \"FromAddr\": \"<string>\",\n  \"ReplyAddr\": \"<string>\",\n  \"EnvelopeFrom\": \"<string>\",\n  \"Recipients\": 123,\n  \"Configuration\": 123,\n  \"SelectionId\": 123,\n  \"ProjectId\": 123,\n  \"ShipmenttypeId\": 123,\n  \"SentNum\": 123,\n  \"DeliveredNum\": 123,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    MailingId: 123,
    Description: '<string>',
    MessageId: 123,
    FolderId: 123,
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    FromAddr: '<string>',
    ReplyAddr: '<string>',
    EnvelopeFrom: '<string>',
    Recipients: 123,
    Configuration: 123,
    SelectionId: 123,
    ProjectId: 123,
    ShipmenttypeId: 123,
    SentNum: 123,
    DeliveredNum: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'MailingId' => 123,
    'Description' => '<string>',
    'MessageId' => 123,
    'FolderId' => 123,
    'StartDate' => '2023-11-07T05:31:56Z',
    'EndDate' => '2023-11-07T05:31:56Z',
    'FromAddr' => '<string>',
    'ReplyAddr' => '<string>',
    'EnvelopeFrom' => '<string>',
    'Recipients' => 123,
    'Configuration' => 123,
    'SelectionId' => 123,
    'ProjectId' => 123,
    'ShipmenttypeId' => 123,
    'SentNum' => 123,
    'DeliveredNum' => 123,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity"

payload = {
    "MailingId": 123,
    "Description": "<string>",
    "MessageId": 123,
    "FolderId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "FromAddr": "<string>",
    "ReplyAddr": "<string>",
    "EnvelopeFrom": "<string>",
    "Recipients": 123,
    "Configuration": 123,
    "SelectionId": 123,
    "ProjectId": 123,
    "ShipmenttypeId": 123,
    "SentNum": 123,
    "DeliveredNum": 123,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    MailingId: 123,
    Description: '<string>',
    MessageId: 123,
    FolderId: 123,
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    FromAddr: '<string>',
    ReplyAddr: '<string>',
    EnvelopeFrom: '<string>',
    Recipients: 123,
    Configuration: 123,
    SelectionId: 123,
    ProjectId: 123,
    ShipmenttypeId: 123,
    SentNum: 123,
    DeliveredNum: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "MailingId": 123,
  "Description": "<string>",
  "MessageId": 123,
  "FolderId": 123,
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "FromAddr": "<string>",
  "ReplyAddr": "<string>",
  "EnvelopeFrom": "<string>",
  "Status": "None",
  "Recipients": 123,
  "Configuration": 123,
  "SelectionId": 123,
  "ProjectId": 123,
  "ShipmenttypeId": 123,
  "SentNum": 123,
  "DeliveredNum": 123,
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Save Mailing Entity

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"MailingId\": 123,\n  \"Description\": \"<string>\",\n  \"MessageId\": 123,\n  \"FolderId\": 123,\n  \"StartDate\": \"2023-11-07T05:31:56Z\",\n  \"EndDate\": \"2023-11-07T05:31:56Z\",\n  \"FromAddr\": \"<string>\",\n  \"ReplyAddr\": \"<string>\",\n  \"EnvelopeFrom\": \"<string>\",\n  \"Recipients\": 123,\n  \"Configuration\": 123,\n  \"SelectionId\": 123,\n  \"ProjectId\": 123,\n  \"ShipmenttypeId\": 123,\n  \"SentNum\": 123,\n  \"DeliveredNum\": 123,\n  \"Registered\": \"2023-11-07T05:31:56Z\",\n  \"RegisteredAssociateId\": 123,\n  \"Updated\": \"2023-11-07T05:31:56Z\",\n  \"UpdatedAssociateId\": 123,\n  \"UpdatedCount\": 123,\n  \"TableRight\": {\n    \"Mask\": \"<string>\",\n    \"Reason\": \"<string>\"\n  },\n  \"FieldProperties\": {}\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    MailingId: 123,
    Description: '<string>',
    MessageId: 123,
    FolderId: 123,
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    FromAddr: '<string>',
    ReplyAddr: '<string>',
    EnvelopeFrom: '<string>',
    Recipients: 123,
    Configuration: 123,
    SelectionId: 123,
    ProjectId: 123,
    ShipmenttypeId: 123,
    SentNum: 123,
    DeliveredNum: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'MailingId' => 123,
    'Description' => '<string>',
    'MessageId' => 123,
    'FolderId' => 123,
    'StartDate' => '2023-11-07T05:31:56Z',
    'EndDate' => '2023-11-07T05:31:56Z',
    'FromAddr' => '<string>',
    'ReplyAddr' => '<string>',
    'EnvelopeFrom' => '<string>',
    'Recipients' => 123,
    'Configuration' => 123,
    'SelectionId' => 123,
    'ProjectId' => 123,
    'ShipmenttypeId' => 123,
    'SentNum' => 123,
    'DeliveredNum' => 123,
    'Registered' => '2023-11-07T05:31:56Z',
    'RegisteredAssociateId' => 123,
    'Updated' => '2023-11-07T05:31:56Z',
    'UpdatedAssociateId' => 123,
    'UpdatedCount' => 123,
    'TableRight' => [
        'Mask' => '<string>',
        'Reason' => '<string>'
    ],
    'FieldProperties' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity"

payload = {
    "MailingId": 123,
    "Description": "<string>",
    "MessageId": 123,
    "FolderId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "EndDate": "2023-11-07T05:31:56Z",
    "FromAddr": "<string>",
    "ReplyAddr": "<string>",
    "EnvelopeFrom": "<string>",
    "Recipients": 123,
    "Configuration": 123,
    "SelectionId": 123,
    "ProjectId": 123,
    "ShipmenttypeId": 123,
    "SentNum": 123,
    "DeliveredNum": 123,
    "Registered": "2023-11-07T05:31:56Z",
    "RegisteredAssociateId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "UpdatedAssociateId": 123,
    "UpdatedCount": 123,
    "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
    },
    "FieldProperties": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    MailingId: 123,
    Description: '<string>',
    MessageId: 123,
    FolderId: 123,
    StartDate: '2023-11-07T05:31:56Z',
    EndDate: '2023-11-07T05:31:56Z',
    FromAddr: '<string>',
    ReplyAddr: '<string>',
    EnvelopeFrom: '<string>',
    Recipients: 123,
    Configuration: 123,
    SelectionId: 123,
    ProjectId: 123,
    ShipmenttypeId: 123,
    SentNum: 123,
    DeliveredNum: 123,
    Registered: '2023-11-07T05:31:56Z',
    RegisteredAssociateId: 123,
    Updated: '2023-11-07T05:31:56Z',
    UpdatedAssociateId: 123,
    UpdatedCount: 123,
    TableRight: {Mask: '<string>', Reason: '<string>'},
    FieldProperties: {}
  })
};

fetch('http://localhost:56350/api/v1/Agents/Marketing/SaveMailingEntity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "MailingId": 123,
  "Description": "<string>",
  "MessageId": 123,
  "FolderId": 123,
  "StartDate": "2023-11-07T05:31:56Z",
  "EndDate": "2023-11-07T05:31:56Z",
  "FromAddr": "<string>",
  "ReplyAddr": "<string>",
  "EnvelopeFrom": "<string>",
  "Status": "None",
  "Recipients": 123,
  "Configuration": 123,
  "SelectionId": 123,
  "ProjectId": 123,
  "ShipmenttypeId": 123,
  "SentNum": 123,
  "DeliveredNum": 123,
  "Registered": "2023-11-07T05:31:56Z",
  "RegisteredAssociateId": 123,
  "Updated": "2023-11-07T05:31:56Z",
  "UpdatedAssociateId": 123,
  "UpdatedCount": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

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.

Body

The MailingEntity that is saved

A mailing (shipment) — the run that sends a message to a set of recipients Carrier object for MailingEntity. Services for the MailingEntity Carrier is available from the Marketing Agent.

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.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes

Response

A mailing (shipment) — the run that sends a message to a set of recipients Carrier object for MailingEntity. Services for the MailingEntity Carrier is available from the Marketing Agent.

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.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes