diff --git a/campaigns.md b/campaigns.md
index 7429257..04dab97 100644
--- a/campaigns.md
+++ b/campaigns.md
@@ -6,6 +6,7 @@ Campaigns have the following structure:
{
id : int64
name : string
+ description : string
created_date : string(datetime)
launch_date : string(datetime)
send_by_date : string(datetime)
@@ -93,6 +94,7 @@ A valid API key
{
"id": 1,
"name": "Example Campaign",
+ "description": "Description of example campaign",
"created_date": "2018-10-08T15:56:29.48815Z",
"launch_date": "2018-10-08T15:56:00Z",
"send_by_date": "0001-01-01T00:00:00Z",
@@ -231,6 +233,7 @@ A valid API key
{
"id": 1,
"name": "Example Campaign",
+ "description": "Description of example campaign",
"created_date": "2018-10-08T15:56:29.48815Z",
"launch_date": "2018-10-08T15:56:00Z",
"send_by_date": "0001-01-01T00:00:00Z",
@@ -384,6 +387,7 @@ The campaign details. See the introduction above for the format of a campaign.
{
"id": 1,
"name": "Example Campaign",
+ "description": "Description of example campaign",
"created_date": "2018-10-08T15:56:29.48815Z",
"launch_date": "2018-10-08T15:56:00Z",
"send_by_date": "0001-01-01T00:00:00Z",
@@ -461,6 +465,7 @@ This method expects the campaign to be provided in JSON format. For the various
```javascript
{
"name":"CC Example Campaign",
+ "description": "Description of example campaign",
"template":{"name":"Example Template"},
"url":"http://localhost",
"page":{"name":"Example Landing Page"},
@@ -515,6 +520,7 @@ A valid API key
{
"id": 1,
"name": "Example Campaign",
+ "description": "Description of example campaign",
"status": "In progress",
"results": [
{
diff --git a/landing-pages.md b/landing-pages.md
index 0cf8f83..7b28d79 100644
--- a/landing-pages.md
+++ b/landing-pages.md
@@ -8,6 +8,7 @@ Landing pages have the following structure:
{
id : int64
name : string
+ description : string
html : string
capture_credentials : bool
capture_passwords : bool
@@ -45,6 +46,7 @@ A valid API key
{
"id": 1,
"name": "Example Page",
+ "description": "Description of example landing page",
"html": "This is a test page",
"capture_credentials": true,
"capture_passwords": true,
@@ -92,6 +94,7 @@ A valid API key
{
"id": 1,
"name": "Example Page",
+ "description": "Description of example landing page",
"html": "This is a test page",
"capture_credentials": true,
"capture_passwords": true,
@@ -154,6 +157,7 @@ The JSON representation of the landing page to be created
{
"id": 1,
"name": "Example Page",
+ "description": "Description of example landing page",
"html": "This is a test page",
"capture_credentials": true,
"capture_passwords": true,
@@ -224,6 +228,7 @@ The JSON representation of the landing page to be modified
{
"id": 1,
"name": "Example Page",
+ "description": "Description of example landing page",
"html": "This is a test page",
"capture_credentials": true,
"capture_passwords": true,
diff --git a/templates.md b/templates.md
index c7a419d..b7577ad 100644
--- a/templates.md
+++ b/templates.md
@@ -10,6 +10,7 @@ Templates have the following structure:
{
id : int64
name : string
+ description : string
subject : string
text : string
html : string
@@ -57,6 +58,7 @@ A valid API key
{
"id" : 1,
"name" : "Password Reset Template",
+ "description" : "Mail template instructing its recipients to follow a password reset link",
"subject" : "{{.FirstName}}, please reset your password.",
"text" : "Please reset your password here: {{.URL}}",
"html" : "Please reset your password here",
@@ -106,6 +108,7 @@ A valid API key
{
"id" : 1,
"name" : "Password Reset Template",
+ "description" : "Mail template instructing its recipients to follow a password reset link",
"subject" : "{{.FirstName}}, please reset your password.",
"text" : "Please reset your password here: {{.URL}}",
"html" : "Please reset your password here",
@@ -166,6 +169,7 @@ The request body should be a JSON representation of a template. See the schema a
{
"id" : 1,
"name" : "Password Reset Template",
+ "description" : "Mail template instructing its recipients to follow a password reset link",
"subject" : "{{.FirstName}}, please reset your password.",
"text" : "Please reset your password here: {{.URL}}",
"html" : "Please reset your password here",