POST api/v1/EmailBuilderCampaigns

Create an Email Builder Campaign

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Type	The type of message	EmailBuilderCampaignType	Required
Name	The campaigns name	string	Required Max length: 255 Min length: 1
Subject	The subject of the email campaign	string	Required Max length: 500 Min length: 1
Preheader	The emails preheader	string	String length: inclusive between 0 and 500
EmailTemplateId	The template used for the email campaign	integer	Required
Dynamic	Dynamic dictionary - only for Trigger messages	Dictionary of string [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "Type": "Newsletter",
  "Name": "sample string 1",
  "Subject": "sample string 2",
  "Preheader": "sample string 3",
  "EmailTemplateId": 4,
  "Dynamic": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadEmailBuilderCampaignDto

Name	Description	Type	Additional information
Id	The ID of the Email Builder Campaign	integer	None.
EmailCampaignId	Id of the Email Campaign. This is only used for Trigger and Test mails.	integer	None.
Type	The type of message	EmailBuilderCampaignType	Required
Name	The campaigns name	string	Required Max length: 255 Min length: 1
Subject	The subject of the email campaign	string	Required Max length: 500 Min length: 1
Preheader	The emails preheader	string	String length: inclusive between 0 and 500
EmailTemplateId	The template used for the email campaign	integer	Required
Dynamic	Dynamic dictionary - only for Trigger messages	Dictionary of string [key] and Object [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "EmailCampaignId": 2,
  "Type": "Newsletter",
  "Name": "sample string 3",
  "Subject": "sample string 4",
  "Preheader": "sample string 5",
  "EmailTemplateId": 6,
  "Dynamic": {
    "sample string 1": {},
    "sample string 3": {}
  }
}