POST api/v1/EmailDispatches

Will create an email dispatch

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
EmailCampaignId	Id of EmailCampaign	integer	Required
ContactId	Id of Contact	integer	None.
SegmentIds	List of SegmentIds	Collection of integer	None.
OrderId	Id of Order	integer	None.
Order2Id	Id of Order2	integer	None.
PointId	Id of Point	integer	None.
Dynamic	Dynamic values on an EmailDispatch	Dictionary of string [key] and Object [value]	None.
StoreIds	Ids of stores	Collection of integer	None.
DateTime	DateTime of EmailDispatch to be sent out. If null, set to UtcNow.	date	None.
IsTest	Indicates if dispatch should be created as test.	boolean	None.
TakeRandom	Sets max number of random contacts for a newsletter dispatch.	integer	None.
LogLevel	Sets level of logging on dispatch	EmailDispatchLogLevel	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailCampaignId": 1,
  "ContactId": 1,
  "SegmentIds": [
    1,
    2
  ],
  "OrderId": 1,
  "Order2Id": 1,
  "PointId": 1,
  "Dynamic": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "StoreIds": [
    1,
    2
  ],
  "DateTime": "2024-11-21T06:36:19.3344357+00:00",
  "IsTest": true,
  "TakeRandom": 1,
  "LogLevel": "None"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadEmailDispatchDto

Name	Description	Type	Additional information
Id	Id of EmailDispatch	integer	None.
Planned	DateTime of the EmailDispatch to be sent out.	date	None.
PlannedUtc		date	None.
EmailCampaignId		integer	None.
EmailCampaignName		string	None.
Subject		string	None.
Preheader		string	None.
Status	Current status of the EmailDispatch	EmailDispatchStatus	None.
Type		EmailDispatchType	None.
Sent		integer	None.
Delivered		integer	None.
Opens		integer	None.
Clicks		integer	None.
DeliveryRatio		decimal number	None.
OpenedRatio		decimal number	None.
ClickRatio		decimal number	None.
BaseSegment		string	None.
InSegments		Collection of string	None.
NotInSegments		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Planned": "2024-11-21T06:36:19.3344357+00:00",
  "PlannedUtc": "2024-11-21T06:36:19.3344357+00:00",
  "EmailCampaignId": 4,
  "EmailCampaignName": "sample string 5",
  "Subject": "sample string 6",
  "Preheader": "sample string 7",
  "Status": "Waiting",
  "Type": "Test",
  "Sent": 8,
  "Delivered": 9,
  "Opens": 10,
  "Clicks": 11,
  "DeliveryRatio": 12.0,
  "OpenedRatio": 13.0,
  "ClickRatio": 14.0,
  "BaseSegment": "sample string 15",
  "InSegments": [
    "sample string 1",
    "sample string 2"
  ],
  "NotInSegments": [
    "sample string 1",
    "sample string 2"
  ]
}