Skip to content

Added documentation for "description" parameter #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added documentation for "description" parameter #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions campaigns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"},
Expand Down Expand Up @@ -515,6 +520,7 @@ A valid API key
{
"id": 1,
"name": "Example Campaign",
"description": "Description of example campaign",
"status": "In progress",
"results": [
{
Expand Down
5 changes: 5 additions & 0 deletions landing-pages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Landing pages have the following structure:
{
id : int64
name : string
description : string
html : string
capture_credentials : bool
capture_passwords : bool
Expand Down Expand Up @@ -45,6 +46,7 @@ A valid API key
{
"id": 1,
"name": "Example Page",
"description": "Description of example landing page",
"html": "<html><head></head><body>This is a test page</body></html>",
"capture_credentials": true,
"capture_passwords": true,
Expand Down Expand Up @@ -92,6 +94,7 @@ A valid API key
{
"id": 1,
"name": "Example Page",
"description": "Description of example landing page",
"html": "<html><head></head><body>This is a test page</body></html>",
"capture_credentials": true,
"capture_passwords": true,
Expand Down Expand Up @@ -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": "<html><head></head><body>This is a test page</body></html>",
"capture_credentials": true,
"capture_passwords": true,
Expand Down Expand Up @@ -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": "<html><head></head><body>This is a test page</body></html>",
"capture_credentials": true,
"capture_passwords": true,
Expand Down
4 changes: 4 additions & 0 deletions templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Templates have the following structure:
{
id : int64
name : string
description : string
subject : string
text : string
html : string
Expand Down Expand Up @@ -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" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
Expand Down Expand Up @@ -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" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
Expand Down Expand Up @@ -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" : "<html><head></head><body>Please reset your password <a href\"{{.URL}}\">here</a></body></html>",
Expand Down