summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorElmer Thomas <elmer@thinkingserious.com>2016-06-09 20:32:45 -0700
committerElmer Thomas <elmer@thinkingserious.com>2016-06-09 20:32:45 -0700
commit96cde7f4239fa7f387351a6690bde966fb5557a3 (patch)
tree0785a96ed12e8c4d5663cf6eea4dc7a5d545df73
parentec88853a3e3803a24775b7f6ec66421f5c05ba2c (diff)
downloadsendgrid-nodejs-96cde7f4239fa7f387351a6690bde966fb5557a3.zip
sendgrid-nodejs-96cde7f4239fa7f387351a6690bde966fb5557a3.tar.gz
sendgrid-nodejs-96cde7f4239fa7f387351a6690bde966fb5557a3.tar.bz2
Formating and links to /mail/send
-rw-r--r--CONTRIBUTING.md7
-rw-r--r--USAGE.md688
-rw-r--r--examples/accesssettings/accesssettings.js6
-rw-r--r--examples/apikeys/apikeys.js6
-rw-r--r--examples/asm/asm.js13
-rw-r--r--examples/browsers/browsers.js11
-rw-r--r--examples/campaigns/campaigns.js13
-rw-r--r--examples/categories/categories.js29
-rw-r--r--examples/clients/clients.js10
-rw-r--r--examples/contactdb/contactdb.js41
-rw-r--r--examples/devices/devices.js9
-rw-r--r--examples/geo/geo.js11
-rw-r--r--examples/ips/ips.js22
-rw-r--r--examples/mail/mail.js4
-rw-r--r--examples/mailboxproviders/mailboxproviders.js11
-rw-r--r--examples/mailsettings/mailsettings.js21
-rw-r--r--examples/partnersettings/partnersettings.js5
-rw-r--r--examples/scopes/scopes.js1
-rw-r--r--examples/stats/stats.js9
-rw-r--r--examples/subusers/subusers.js58
-rw-r--r--examples/suppression/suppression.js43
-rw-r--r--examples/templates/templates.js10
-rw-r--r--examples/trackingsettings/trackingsettings.js11
-rw-r--r--examples/user/user.js29
-rw-r--r--examples/whitelabel/whitelabel.js41
25 files changed, 768 insertions, 341 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 60774e7..8296354 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -84,7 +84,6 @@ You will need to setup the following environment to use the SendGrid example:
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env
-node examples/example.js
```
##### Execute: #####
@@ -132,7 +131,7 @@ For the purposes of contributing to this repo, please update the [`test.js`](htt
To run the tests:
```bash
-mocha --recursive
+mocha
```
<a name="style_guidelines_and_naming_conventions"></a>
@@ -146,10 +145,6 @@ Please run your code through:
- [ESLint](http://eslint.org/) with the tandard style guide.
-Please run your code through:
-
-<!--- list of linters to use --->
-
## Creating a Pull Request<a name="creating_a_pull_request"></a>
1. [Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
diff --git a/USAGE.md b/USAGE.md
index 8e303fa..1084308 100644
--- a/USAGE.md
+++ b/USAGE.md
@@ -46,6 +46,7 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### GET /access_settings/activity
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
@@ -69,16 +70,17 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### POST /access_settings/whitelist
+
```javascript
var request = sg.emptyRequest()
request.body = {
"ips": [
{
"ip": "192.168.1.1"
- },
+ },
{
"ip": "192.*.*.*"
- },
+ },
{
"ip": "192.168.1.3/32"
}
@@ -102,6 +104,7 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### GET /access_settings/whitelist
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -124,12 +127,13 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### DELETE /access_settings/whitelist
+
```javascript
var request = sg.emptyRequest()
request.body = {
"ids": [
- 1,
- 2,
+ 1,
+ 2,
3
]
};
@@ -153,6 +157,7 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### GET /access_settings/whitelist/{rule_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -175,6 +180,7 @@ For more information, please see our [User Guide](http://sendgrid.com/docs/User_
### DELETE /access_settings/whitelist/{rule_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -202,13 +208,14 @@ See the [API Key Permissions List](https://sendgrid.com/docs/API_Reference/Web_A
### POST /api_keys
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "name": "My API Key",
+ "name": "My API Key",
"scopes": [
- "mail.send",
- "alerts.create",
+ "mail.send",
+ "alerts.create",
"alerts.read"
]
};
@@ -228,6 +235,7 @@ The API Keys feature allows customers to be able to generate an API Key credenti
### GET /api_keys
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -250,12 +258,13 @@ The API Keys feature allows customers to be able to generate an API Key credenti
### PUT /api_keys/{api_key_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "name": "A New Hope",
+ "name": "A New Hope",
"scopes": [
- "user.profile.read",
+ "user.profile.read",
"user.profile.update"
]
};
@@ -283,6 +292,7 @@ The API Keys feature allows customers to be able to generate an API Key credenti
### PATCH /api_keys/{api_key_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -304,6 +314,7 @@ If the API Key ID does not exist an HTTP 404 will be returned.
### GET /api_keys/{api_key_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -330,6 +341,7 @@ The API Keys feature allows customers to be able to generate an API Key credenti
### DELETE /api_keys/{api_key_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -355,11 +367,12 @@ Each user can create up to 25 different suppression groups.
### POST /asm/groups
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "description": "Suggestions for products our users might like.",
- "is_default": true,
+ "description": "Suggestions for products our users might like.",
+ "is_default": true,
"name": "Product Suggestions"
};
request.method = 'POST'
@@ -378,6 +391,7 @@ This endpoint will return information for each group ID that you include in your
### GET /asm/groups
+
```javascript
var request = sg.emptyRequest()
request.queryParams["id"] = '1'
@@ -401,11 +415,12 @@ Each user can create up to 25 different suppression groups.
### PATCH /asm/groups/{group_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "description": "Suggestions for items our users might like.",
- "id": 103,
+ "description": "Suggestions for items our users might like.",
+ "id": 103,
"name": "Item Suggestions"
};
request.method = 'PATCH'
@@ -428,6 +443,7 @@ Each user can create up to 25 different suppression groups.
### GET /asm/groups/{group_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -452,6 +468,7 @@ Each user can create up to 25 different suppression groups.
### DELETE /asm/groups/{group_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -472,11 +489,12 @@ Suppressions are recipient email addresses that are added to [unsubscribe groups
### POST /asm/groups/{group_id}/suppressions
+
```javascript
var request = sg.emptyRequest()
request.body = {
"recipient_emails": [
- "test1@example.com",
+ "test1@example.com",
"test2@example.com"
]
};
@@ -496,6 +514,7 @@ Suppressions are recipient email addresses that are added to [unsubscribe groups
### GET /asm/groups/{group_id}/suppressions
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -514,6 +533,7 @@ Suppressions are recipient email addresses that are added to [unsubscribe groups
### DELETE /asm/groups/{group_id}/suppressions/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -532,6 +552,7 @@ Suppressions are email addresses that can be added to [groups](https://sendgrid.
### GET /asm/suppressions
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -550,11 +571,12 @@ A global suppression (or global unsubscribe) is an email address of a recipient
### POST /asm/suppressions/global
+
```javascript
var request = sg.emptyRequest()
request.body = {
"recipient_emails": [
- "test1@example.com",
+ "test1@example.com",
"test2@example.com"
]
};
@@ -576,6 +598,7 @@ A global suppression (or global unsubscribe) is an email address of a recipient
### GET /asm/suppressions/global/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -594,6 +617,7 @@ A global suppression (or global unsubscribe) is an email address of a recipient
### DELETE /asm/suppressions/global/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -612,6 +636,7 @@ Suppressions are email addresses that can be added to [groups](https://sendgrid.
### GET /asm/suppressions/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -625,7 +650,7 @@ Suppressions are email addresses that can be added to [groups](https://sendgrid.
<a name="browsers"></a>
# BROWSERS
-## Retrieve email statistics by browser.
+## Retrieve email statistics by browser.
**This endpoint allows you to retrieve your email statistics segmented by browser type.**
@@ -635,6 +660,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /browsers/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -668,26 +694,27 @@ For more information:
### POST /campaigns
+
```javascript
var request = sg.emptyRequest()
request.body = {
"categories": [
"spring line"
- ],
- "custom_unsubscribe_url": "",
- "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
- "ip_pool": "marketing",
+ ],
+ "custom_unsubscribe_url": "",
+ "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
+ "ip_pool": "marketing",
"list_ids": [
- 110,
+ 110,
124
- ],
- "plain_content": "Check out our spring line!",
+ ],
+ "plain_content": "Check out our spring line!",
"segment_ids": [
110
- ],
- "sender_id": 124451,
- "subject": "New Products for Spring!",
- "suppression_group_id": 42,
+ ],
+ "sender_id": 124451,
+ "subject": "New Products for Spring!",
+ "suppression_group_id": 42,
"title": "March Newsletter"
};
request.method = 'POST'
@@ -712,6 +739,7 @@ For more information:
### GET /campaigns
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '0'
@@ -734,15 +762,16 @@ For more information:
### PATCH /campaigns/{campaign_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
"categories": [
"summer line"
- ],
- "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
- "plain_content": "Check out our summer line!",
- "subject": "New Products for Summer!",
+ ],
+ "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
+ "plain_content": "Check out our summer line!",
+ "subject": "New Products for Summer!",
"title": "May Newsletter"
};
request.method = 'PATCH'
@@ -765,6 +794,7 @@ For more information:
### GET /campaigns/{campaign_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -787,6 +817,7 @@ For more information:
### DELETE /campaigns/{campaign_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -807,6 +838,7 @@ For more information:
### PATCH /campaigns/{campaign_id}/schedules
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -830,6 +862,7 @@ For more information:
### POST /campaigns/{campaign_id}/schedules
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -853,6 +886,7 @@ For more information:
### GET /campaigns/{campaign_id}/schedules
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -876,6 +910,7 @@ For more information:
### DELETE /campaigns/{campaign_id}/schedules
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -898,6 +933,7 @@ For more information:
### POST /campaigns/{campaign_id}/schedules/now
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -920,6 +956,7 @@ For more information:
### POST /campaigns/{campaign_id}/schedules/test
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -944,6 +981,7 @@ Categories can help organize your email analytics by enabling you to tag emails
### GET /categories
+
```javascript
var request = sg.emptyRequest()
request.queryParams["category"] = 'test_string'
@@ -963,10 +1001,11 @@ Categories can help organize your email analytics by enabling you to tag emails
If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
-Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
+Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
### GET /categories/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -989,10 +1028,11 @@ Categories allow you to group your emails together according to broad topics tha
If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
-Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
+Categories allow you to group your emails together according to broad topics that you define. For more information, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Statistics/categories.html).
### GET /categories/stats/sums
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -1023,6 +1063,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /clients/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
@@ -1052,6 +1093,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /clients/{client_type}/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
@@ -1076,10 +1118,11 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### POST /contactdb/custom_fields
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "name": "pet",
+ "name": "pet",
"type": "text"
};
request.method = 'POST'
@@ -1092,12 +1135,13 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
```
## Retrieve all custom fields
-**This endpoint allows you to retrieve all custom fields.**
+**This endpoint allows you to retrieve all custom fields.**
The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html).
### GET /contactdb/custom_fields
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1116,6 +1160,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### GET /contactdb/custom_fields/{custom_field_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1134,6 +1179,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### DELETE /contactdb/custom_fields/{custom_field_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -1152,6 +1198,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### POST /contactdb/lists
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -1173,6 +1220,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/lists
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1191,12 +1239,13 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### DELETE /contactdb/lists
+
```javascript
var request = sg.emptyRequest()
request.body = [
- 1,
- 2,
- 3,
+ 1,
+ 2,
+ 3,
4
];
request.method = 'DELETE'
@@ -1216,6 +1265,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### PATCH /contactdb/lists/{list_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -1238,6 +1288,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/lists/{list_id}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["list_id"] = '0'
@@ -1257,6 +1308,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### DELETE /contactdb/lists/{list_id}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
@@ -1278,10 +1330,11 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### POST /contactdb/lists/{list_id}/recipients
+
```javascript
var request = sg.emptyRequest()
request.body = [
- "recipient_id1",
+ "recipient_id1",
"recipient_id2"
];
request.method = 'POST'
@@ -1294,12 +1347,13 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
```
## Retrieve all recipients on a List
-**This endpoint allows you to retrieve all recipients on the list with the given ID.**
+**This endpoint allows you to retrieve all recipients on the list with the given ID.**
The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.com/docs/User_Guide/Marketing_Campaigns/index.html) recipients.
### GET /contactdb/lists/{list_id}/recipients
+
```javascript
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
@@ -1321,6 +1375,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### POST /contactdb/lists/{list_id}/recipients/{recipient_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -1339,6 +1394,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["recipient_id"] = '0'
@@ -1363,12 +1419,13 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### PATCH /contactdb/recipients
+
```javascript
var request = sg.emptyRequest()
request.body = [
{
- "email": "jones@example.com",
- "first_name": "Guy",
+ "email": "jones@example.com",
+ "first_name": "Guy",
"last_name": "Jones"
}
];
@@ -1390,19 +1447,20 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### POST /contactdb/recipients
+
```javascript
var request = sg.emptyRequest()
request.body = [
{
- "age": 25,
- "email": "example@example.com",
- "first_name": "",
+ "age": 25,
+ "email": "example@example.com",
+ "first_name": "",
"last_name": "User"
- },
+ },
{
- "age": 25,
- "email": "example2@example.com",
- "first_name": "Example",
+ "age": 25,
+ "email": "example2@example.com",
+ "first_name": "Example",
"last_name": "User"
}
];
@@ -1425,6 +1483,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/recipients
+
```javascript
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
@@ -1447,10 +1506,11 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### DELETE /contactdb/recipients
+
```javascript
var request = sg.emptyRequest()
request.body = [
- "recipient_id1",
+ "recipient_id1",
"recipient_id2"
];
request.method = 'DELETE'
@@ -1471,6 +1531,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/recipients/billable_count
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1489,6 +1550,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### GET /contactdb/recipients/count
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1516,6 +1578,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### GET /contactdb/recipients/search
+
```javascript
var request = sg.emptyRequest()
request.queryParams["{field_name}"] = 'test_string'
@@ -1535,6 +1598,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/recipients/{recipient_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1553,6 +1617,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### DELETE /contactdb/recipients/{recipient_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -1573,6 +1638,7 @@ The Contacts API helps you manage your [Marketing Campaigns](https://sendgrid.co
### GET /contactdb/recipients/{recipient_id}/lists
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1591,6 +1657,7 @@ The contactdb is a database of your contacts for [SendGrid Marketing Campaigns](
### GET /contactdb/reserved_fields
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1612,14 +1679,14 @@ List Id:
* Send this to segment from an existing list
* Don't send this in order to segment from your entire contactdb.
-Valid operators for create and update depend on the type of the field you are segmenting:
+Valid operators for create and update depend on the type of the field you are segmenting:
-* **Dates:** "eq", "ne", "lt" (before), "gt" (after)
-* **Text:** "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value)
-* **Numbers:** "eq", "lt", "gt"
-* **Email Clicks and Opens:** "eq" (opened), "ne" (not opened)
+* **Dates:** "eq", "ne", "lt" (before), "gt" (after)
+* **Text:** "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value)
+* **Numbers:** "eq", "lt", "gt"
+* **Email Clicks and Opens:** "eq" (opened), "ne" (not opened)
-Segment conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either *clicks.campaign_identifier* or *opens.campaign_identifier*. The condition value should be a string containing the id of a completed campaign.
+Segment conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either *clicks.campaign_identifier* or *opens.campaign_identifier*. The condition value should be a string containing the id of a completed campaign.
Segments may contain multiple condtions, joined by an "and" or "or" in the "and_or" field. The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
@@ -1629,30 +1696,31 @@ For more information about segments in Marketing Campaigns, please see our [User
### POST /contactdb/segments
+
```javascript
var request = sg.emptyRequest()
request.body = {
"conditions": [
{
- "and_or": "",
- "field": "last_name",
- "operator": "eq",
+ "and_or": "",
+ "field": "last_name",
+ "operator": "eq",
"value": "Miller"
- },
+ },
{
- "and_or": "and",
- "field": "last_clicked",
- "operator": "gt",
+ "and_or": "and",
+ "field": "last_clicked",
+ "operator": "gt",
"value": "01/02/2015"
- },
+ },
{
- "and_or": "or",
- "field": "clicks.campaign_identifier",
- "operator": "eq",
+ "and_or": "or",
+ "field": "clicks.campaign_identifier",
+ "operator": "eq",
"value": "513"
}
- ],
- "list_id": 4,
+ ],
+ "list_id": 4,
"name": "Last Name Miller"
};
request.method = 'POST'
@@ -1673,6 +1741,7 @@ For more information about segments in Marketing Campaigns, please see our [User
### GET /contactdb/segments
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1693,18 +1762,19 @@ For more information about segments in Marketing Campaigns, please see our [User
### PATCH /contactdb/segments/{segment_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
"conditions": [
{
- "and_or": "",
- "field": "last_name",
- "operator": "eq",
+ "and_or": "",
+ "field": "last_name",
+ "operator": "eq",
"value": "Miller"
}
- ],
- "list_id": 5,
+ ],
+ "list_id": 5,
"name": "The Millers"
};
request.queryParams["segment_id"] = 'test_string'
@@ -1726,6 +1796,7 @@ For more information about segments in Marketing Campaigns, please see our [User
### GET /contactdb/segments/{segment_id}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["segment_id"] = '0'
@@ -1749,6 +1820,7 @@ For more information about segments in Marketing Campaigns, please see our [User
### DELETE /contactdb/segments/{segment_id}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
@@ -1770,6 +1842,7 @@ For more information about segments in Marketing Campaigns, please see our [User
### GET /contactdb/segments/{segment_id}/recipients
+
```javascript
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
@@ -1804,6 +1877,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /devices/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
@@ -1832,6 +1906,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /geo/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -1861,6 +1936,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
### GET /ips
+
```javascript
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
@@ -1884,6 +1960,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
### GET /ips/assigned
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1908,6 +1985,7 @@ If an IP pool is NOT specified for an email, it will use any IP available, inclu
### POST /ips/pools
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -1933,6 +2011,7 @@ If an IP pool is NOT specified for an email, it will use any IP available, inclu
### GET /ips/pools
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -1955,6 +2034,7 @@ If an IP pool is NOT specified for an email, it will use any IP available, inclu
### PUT /ips/pools/{pool_name}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -1980,6 +2060,7 @@ If an IP pool is NOT specified for an email, it will use any IP available, inclu
### GET /ips/pools/{pool_name}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2002,6 +2083,7 @@ If an IP pool is NOT specified for an email, it will use any IP available, inclu
### DELETE /ips/pools/{pool_name}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -2022,6 +2104,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
### POST /ips/pools/{pool_name}/ips
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -2045,6 +2128,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
### DELETE /ips/pools/{pool_name}/ips/{ip}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -2065,6 +2149,7 @@ For more general information about warming up IPs, please see our [Classroom](ht
### POST /ips/warmup
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -2088,6 +2173,7 @@ For more general information about warming up IPs, please see our [Classroom](ht
### GET /ips/warmup
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2108,6 +2194,7 @@ For more general information about warming up IPs, please see our [Classroom](ht
### GET /ips/warmup/{ip_address}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2128,6 +2215,7 @@ For more general information about warming up IPs, please see our [Classroom](ht
### DELETE /ips/warmup/{ip_address}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -2148,6 +2236,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
### GET /ips/{ip_address}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2165,7 +2254,7 @@ A single IP address or a range of IP addresses may be dedicated to an account in
**This endpoint allows you to generate a new batch ID. This batch ID can be associated with scheduled sends via the mail/send endpoint.**
-If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
+If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
More Information:
@@ -2173,6 +2262,7 @@ More Information:
### POST /mail/batch
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -2187,7 +2277,7 @@ More Information:
**This endpoint allows you to validate a batch ID.**
-If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
+If you set the SMTPAPI header `batch_id`, it allows you to then associate multiple scheduled mail/send requests together with the same ID. Then at anytime up to 10 minutes before the schedule date, you can cancel all of the mail/send requests that have this batch ID by calling the Cancel Scheduled Send endpoint.
More Information:
@@ -2195,6 +2285,7 @@ More Information:
### GET /mail/batch/{batch_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2218,147 +2309,149 @@ For more detailed information about how to use the v3 Mail Send endpoint, please
### POST /mail/send/beta
+// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/lib/helpers/mail/README.md).
+
```javascript
var request = sg.emptyRequest()
request.body = {
"asm": {
- "group_id": 1,
+ "group_id": 1,
"groups_to_display": [
- 1,
- 2,
+ 1,
+ 2,
3
]
- },
+ },
"attachments": [
{
- "content": "[BASE64 encoded content block here]",
- "content_id": "ii_139db99fdb5c3704",
- "disposition": "inline",
- "filename": "file1.jpg",
- "name": "file1",
+ "content": "[BASE64 encoded content block here]",
+ "content_id": "ii_139db99fdb5c3704",
+ "disposition": "inline",
+ "filename": "file1.jpg",
+ "name": "file1",
"type": "jpg"
}
- ],
- "batch_id": "[YOUR BATCH ID GOES HERE]",
+ ],
+ "batch_id": "[YOUR BATCH ID GOES HERE]",
"categories": [
- "category1",
+ "category1",
"category2"
- ],
+ ],
"content": [
{
- "type": "text/html",
+ "type": "text/html",
"value": "<html><p>Hello, world!</p><img src=[CID GOES HERE]></img></html>"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"from": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
- "headers": {},
- "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
+ },
+ "headers": {},
+ "ip_pool_name": "[YOUR POOL NAME GOES HERE]",
"mail_settings": {
"bcc": {
- "email": "ben.doe@example.com",
+ "email": "ben.doe@example.com",
"enable": true
- },
+ },
"bypass_list_management": {
"enable": true
- },
+ },
"footer": {
- "enable": true,
- "html": "<p>Thanks</br>The SendGrid Team</p>",
+ "enable": true,
+ "html": "<p>Thanks</br>The SendGrid Team</p>",
"text": "Thanks,/n The SendGrid Team"
- },
+ },
"sandbox_mode": {
"enable": false
- },
+ },
"spam_check": {
- "enable": true,
- "post_to_url": "http://example.com/compliance",
+ "enable": true,
+ "post_to_url": "http://example.com/compliance",
"threshold": 3
}
- },
+ },
"personalizations": [
{
"bcc": [
{
- "email": "sam.doe@example.com",
+ "email": "sam.doe@example.com",
"name": "Sam Doe"
}
- ],
+ ],
"cc": [
{
- "email": "jane.doe@example.com",
+ "email": "jane.doe@example.com",
"name": "Jane Doe"
}
- ],
+ ],
"custom_args": {
- "New Argument 1": "New Value 1",
- "activationAttempt": "1",
+ "New Argument 1": "New Value 1",
+ "activationAttempt": "1",
"customerAccountNumber": "[CUSTOMER ACCOUNT NUMBER GOES HERE]"
- },
+ },
"headers": {
- "X-Accept-Language": "en",
+ "X-Accept-Language": "en",
"X-Mailer": "MyApp"
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
"substitutions": {
"sub": {
"%name%": [
- "John",
- "Jane",
+ "John",
+ "Jane",
"Sam"
]
}
- },
+ },
"to": [
{
- "email": "john.doe@example.com",
+ "email": "john.doe@example.com",
"name": "John Doe"
}
]
}
- ],
+ ],
"reply_to": {
- "email": "sam.smith@example.com",
+ "email": "sam.smith@example.com",
"name": "Sam Smith"
- },
+ },
"sections": {
"section": {
- ":sectionName1": "section 1 text",
+ ":sectionName1": "section 1 text",
":sectionName2": "section 2 text"
}
- },
- "send_at": 1409348513,
- "subject": "Hello, World!",
- "template_id": "[YOUR TEMPLATE ID GOES HERE]",
+ },
+ "send_at": 1409348513,
+ "subject": "Hello, World!",
+ "template_id": "[YOUR TEMPLATE ID GOES HERE]",
"tracking_settings": {
"click_tracking": {
- "enable": true,
+ "enable": true,
"enable_text": true
- },
+ },
"ganalytics": {
- "enable": true,
- "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
- "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
- "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
- "utm_name": "[NAME OF YOUR CAMPAIGN]",
+ "enable": true,
+ "utm_campaign": "[NAME OF YOUR REFERRER SOURCE]",
+ "utm_content": "[USE THIS SPACE TO DIFFERENTIATE YOUR EMAIL FROM ADS]",
+ "utm_medium": "[NAME OF YOUR MARKETING MEDIUM e.g. email]",
+ "utm_name": "[NAME OF YOUR CAMPAIGN]",
"utm_term": "[IDENTIFY PAID KEYWORDS HERE]"
- },
+ },
"open_tracking": {
- "enable": true,
+ "enable": true,
"substitution_tag": "%opentrack"
- },
+ },
"subscription_tracking": {
- "enable": true,
- "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
- "substitution_tag": "<%click here%>",
+ "enable": true,
+ "html": "If you would like to unsubscribe and stop receiving these emails <% clickhere %>.",
+ "substitution_tag": "<%click here%>",
"text": "If you would like to unsubscribe and stop receiveing these emails <% click here %>."
}
}
@@ -2382,6 +2475,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
@@ -2404,12 +2498,13 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/address_whitelist
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
+ "enabled": true,
"list": [
- "email1@example.com",
+ "email1@example.com",
"example.com"
]
};
@@ -2431,6 +2526,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/address_whitelist
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2451,10 +2547,11 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/bcc
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "email@example.com",
+ "email": "email@example.com",
"enabled": false
};
request.method = 'PATCH'
@@ -2475,6 +2572,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/bcc
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2495,11 +2593,12 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/bounce_purge
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
- "hard_bounces": 5,
+ "enabled": true,
+ "hard_bounces": 5,
"soft_bounces": 5
};
request.method = 'PATCH'
@@ -2520,6 +2619,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/bounce_purge
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2540,11 +2640,12 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/footer
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
- "html_content": "...",
+ "enabled": true,
+ "html_content": "...",
"plain_content": "..."
};
request.method = 'PATCH'
@@ -2565,6 +2666,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/footer
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2585,10 +2687,11 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/forward_bounce
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "example@example.com",
+ "email": "example@example.com",
"enabled": true
};
request.method = 'PATCH'
@@ -2609,6 +2712,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/forward_bounce
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2629,10 +2733,11 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/forward_spam
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "",
+ "email": "",
"enabled": false
};
request.method = 'PATCH'
@@ -2653,6 +2758,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/forward_spam
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2673,6 +2779,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/plain_content
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -2696,6 +2803,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/plain_content
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2716,11 +2824,12 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/spam_check
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
- "max_score": 5,
+ "enabled": true,
+ "max_score": 5,
"url": "url"
};
request.method = 'PATCH'
@@ -2741,6 +2850,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/spam_check
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2755,7 +2865,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
**This endpoint allows you to update your current legacy email template settings.**
-This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
+This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.
@@ -2763,10 +2873,11 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### PATCH /mail_settings/template
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
+ "enabled": true,
"html_content": "<% body %>"
};
request.method = 'PATCH'
@@ -2781,7 +2892,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
**This endpoint allows you to retrieve your current legacy email template settings.**
-This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
+This setting refers to our original email templates. We currently support more fully featured [transactional templates](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
The legacy email template setting wraps an HTML template around your email content. This can be useful for sending out marketing email and/or other HTML formatted messages.
@@ -2789,6 +2900,7 @@ Mail settings allow you to tell SendGrid specific things to do to every email th
### GET /mail_settings/template
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2812,6 +2924,7 @@ Advanced Stats provide a more in-depth view of your email statistics and the act
### GET /mailbox_providers/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -2839,6 +2952,7 @@ Our partner settings allow you to integrate your SendGrid account with our partn
### GET /partner_settings
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
@@ -2861,11 +2975,12 @@ By integrating with New Relic, you can send your SendGrid email statistics to yo
### PATCH /partner_settings/new_relic
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enable_subuser_statistics": true,
- "enabled": true,
+ "enable_subuser_statistics": true,
+ "enabled": true,
"license_key": ""
};
request.method = 'PATCH'
@@ -2886,6 +3001,7 @@ By integrating with New Relic, you can send your SendGrid email statistics to yo
### GET /partner_settings/new_relic
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2903,10 +3019,11 @@ By integrating with New Relic, you can send your SendGrid email statistics to yo
**This endpoint returns a list of all scopes that this user has access to.**
-API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
+API Keys can be used to authenticate the use of [SendGrids v3 Web API](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html), or the [Mail API Endpoint](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). API Keys may be assigned certain permissions, or scopes, that limit which API endpoints they are able to access. For a more detailed explanation of how you can use API Key permissios, please visit our [User Guide](https://sendgrid.com/docs/User_Guide/Settings/api_keys.html#-API-Key-Permissions) or [Classroom](https://sendgrid.com/docs/Classroom/Basics/API/api_key_permissions.html).
### GET /scopes
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -2928,6 +3045,7 @@ Parent accounts will see aggregated stats for their account and all subuser acco
### GET /stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
@@ -2957,15 +3075,16 @@ For more information about Subusers:
### POST /subusers
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "John@example.com",
+ "email": "John@example.com",
"ips": [
- "1.1.1.1",
+ "1.1.1.1",
"2.2.2.2"
- ],
- "password": "johns_password",
+ ],
+ "password": "johns_password",
"username": "John@example.com"
};
request.method = 'POST'
@@ -2987,6 +3106,7 @@ For more information about Subusers:
### GET /subusers
+
```javascript
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
@@ -3008,6 +3128,7 @@ This endpoint allows you to request the reputations for your subusers.
### GET /subusers/reputations
+
```javascript
var request = sg.emptyRequest()
request.queryParams["usernames"] = 'test_string'
@@ -3031,6 +3152,7 @@ For more information, see our [User Guide](https://sendgrid.com/docs/User_Guide/
### GET /subusers/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -3060,6 +3182,7 @@ For more information, see our [User Guide](https://sendgrid.com/docs/User_Guide/
### GET /subusers/stats/monthly
+
```javascript
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
@@ -3087,6 +3210,7 @@ For more information, see our [User Guide](https://sendgrid.com/docs/User_Guide/
### GET /subusers/stats/sums
+
```javascript
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
@@ -3115,6 +3239,7 @@ For more information about Subusers:
### PATCH /subusers/{subuser_name}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -3139,6 +3264,7 @@ For more information about Subusers:
### DELETE /subusers/{subuser_name}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3151,7 +3277,7 @@ For more information about Subusers:
```
## Update IPs assigned to a subuser
-Each subuser should be assigned to an IP address, from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have their own, or multiple, IP addresses as well.
+Each subuser should be assigned to an IP address, from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have their own, or multiple, IP addresses as well.
More information:
@@ -3160,6 +3286,7 @@ More information:
### PUT /subusers/{subuser_name}/ips
+
```javascript
var request = sg.emptyRequest()
request.body = [
@@ -3179,10 +3306,11 @@ Subuser monitor settings allow you to receive a sample of an outgoing message by
### PUT /subusers/{subuser_name}/monitor
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "example@example.com",
+ "email": "example@example.com",
"frequency": 500
};
request.method = 'PUT'
@@ -3199,10 +3327,11 @@ Subuser monitor settings allow you to receive a sample of an outgoing message by
### POST /subusers/{subuser_name}/monitor
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "email": "example@example.com",
+ "email": "example@example.com",
"frequency": 50000
};
request.method = 'POST'
@@ -3219,6 +3348,7 @@ Subuser monitor settings allow you to receive a sample of an outgoing message by
### GET /subusers/{subuser_name}/monitor
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3235,6 +3365,7 @@ Subuser monitor settings allow you to receive a sample of an outgoing message by
### DELETE /subusers/{subuser_name}/monitor
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3258,6 +3389,7 @@ For more information, see our [User Guide](https://sendgrid.com/docs/User_Guide/
### GET /subusers/{subuser_name}/stats/monthly
+
```javascript
var request = sg.emptyRequest()
request.queryParams["date"] = 'test_string'
@@ -3286,6 +3418,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/blocks
+
```javascript
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
@@ -3304,9 +3437,9 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
**This endpoint allows you to delete all email addresses on your blocks list.**
-There are two options for deleting blocked emails:
+There are two options for deleting blocked emails:
-1. You can delete all blocked emails by setting `delete_all` to true in the request body.
+1. You can delete all blocked emails by setting `delete_all` to true in the request body.
2. You can delete some blocked emails by specifying the email addresses in an array in the request body.
[Blocks](https://sendgrid.com/docs/Glossary/blocks.html) happen when your message was rejected for a reason related to the message, not the recipient address. This can happen when your mail server IP address has been added to a blacklist or blocked by an ISP, or if the message content is flagged by a filter on the receiving server.
@@ -3315,12 +3448,13 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/blocks
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "delete_all": false,
+ "delete_all": false,
"emails": [
- "example1@example.com",
+ "example1@example.com",
"example2@example.com"
]
};
@@ -3342,6 +3476,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/blocks/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3362,6 +3497,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/blocks/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3376,15 +3512,16 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
**This endpoint allows you to retrieve all of your bounces.**
-Bounces are messages that are returned to the server that sent it.
+Bounces are messages that are returned to the server that sent it.
-For more information see:
+For more information see:
* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
### GET /suppression/bounces
+
```javascript
var request = sg.emptyRequest()
request.queryParams["start_time"] = '0'
@@ -3403,7 +3540,7 @@ For more information see:
Bounces are messages that are returned to the server that sent it.
-For more information see:
+For more information see:
* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
@@ -3413,12 +3550,13 @@ Note: the `delete_all` and `emails` parameters should be used independently of e
### DELETE /suppression/bounces
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "delete_all": true,
+ "delete_all": true,
"emails": [
- "example@example.com",
+ "example@example.com",
"example2@example.com"
]
};
@@ -3436,7 +3574,7 @@ Note: the `delete_all` and `emails` parameters should be used independently of e
Bounces are messages that are returned to the server that sent it.
-For more information see:
+For more information see:
* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
@@ -3444,6 +3582,7 @@ For more information see:
### GET /suppression/bounces/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3458,9 +3597,9 @@ For more information see:
**This endpoint allows you to remove an email address from your bounce list.**
-Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.
+Bounces are messages that are returned to the server that sent it. This endpoint allows you to delete a single email addresses from your bounce list.
-For more information see:
+For more information see:
* [User Guide > Bounces](https://sendgrid.com/docs/User_Guide/Suppressions/bounces.html) for more information
* [Glossary > Bounces](https://sendgrid.com/docs/Glossary/Bounces.html)
@@ -3468,6 +3607,7 @@ For more information see:
### DELETE /suppression/bounces/{email}
+
```javascript
var request = sg.emptyRequest()
request.queryParams["email_address"] = 'example@example.com'
@@ -3491,6 +3631,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/invalid_emails
+
```javascript
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
@@ -3509,7 +3650,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
**This endpoint allows you to remove email addresses from your invalid email address list.**
-There are two options for deleting invalid email addresses:
+There are two options for deleting invalid email addresses:
1) You can delete all invalid email addresses by setting `delete_all` to true in the request body.
2) You can delete some invalid email addresses by specifying certain addresses in an array in the request body.
@@ -3522,12 +3663,13 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/invalid_emails
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "delete_all": false,
+ "delete_all": false,
"emails": [
- "example1@example.com",
+ "example1@example.com",
"example2@example.com"
]
};
@@ -3551,6 +3693,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/invalid_emails/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3573,6 +3716,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/invalid_emails/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3593,6 +3737,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/spam_report/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3613,6 +3758,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/spam_report/{email}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3633,6 +3779,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### GET /suppression/spam_reports
+
```javascript
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
@@ -3651,9 +3798,9 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
**This endpoint allows you to delete your spam reports.**
-There are two options for deleting spam reports:
+There are two options for deleting spam reports:
-1) You can delete all spam reports by setting "delete_all" to true in the request body.
+1) You can delete all spam reports by setting "delete_all" to true in the request body.
2) You can delete some spam reports by specifying the email addresses in an array in the request body.
[Spam reports](https://sendgrid.com/docs/Glossary/spam_reports.html) happen when a recipient indicates that they think your email is [spam](https://sendgrid.com/docs/Glossary/spam.html) and then their email provider reports this to SendGrid.
@@ -3662,12 +3809,13 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/User
### DELETE /suppression/spam_reports
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "delete_all": false,
+ "delete_all": false,
"emails": [
- "example1@example.com",
+ "example1@example.com",
"example2@example.com"
]
};
@@ -3687,6 +3835,7 @@ A global suppression (or global unsubscribe) is an email address of a recipient
### GET /suppression/unsubscribes
+
```javascript
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
@@ -3714,6 +3863,7 @@ Transactional templates are templates created specifically for transactional ema
### POST /templates
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -3737,6 +3887,7 @@ Transactional templates are templates created specifically for transactional ema
### GET /templates
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3758,6 +3909,7 @@ Transactional templates are templates created specifically for transactional ema
### PATCH /templates/{template_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -3782,6 +3934,7 @@ Transactional templates are templates created specifically for transactional ema
### GET /templates/{template_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3803,6 +3956,7 @@ Transactional templates are templates created specifically for transactional ema
### DELETE /templates/{template_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3824,14 +3978,15 @@ For more information about transactional templates, please see our [User Guide](
### POST /templates/{template_id}/versions
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "active": 1,
- "html_content": "<%body%>",
- "name": "example_version_name",
- "plain_content": "<%body%>",
- "subject": "<%subject%>",
+ "active": 1,
+ "html_content": "<%body%>",
+ "name": "example_version_name",
+ "plain_content": "<%body%>",
+ "subject": "<%subject%>",
"template_id": "ddb96bbc-9b92-425e-8979-99464621b543"
};
request.method = 'POST'
@@ -3858,13 +4013,14 @@ For more information about transactional templates, please see our [User Guide](
### PATCH /templates/{template_id}/versions/{version_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "active": 1,
- "html_content": "<%body%>",
- "name": "updated_example_name",
- "plain_content": "<%body%>",
+ "active": 1,
+ "html_content": "<%body%>",
+ "name": "updated_example_name",
+ "plain_content": "<%body%>",
"subject": "<%subject%>"
};
request.method = 'PATCH'
@@ -3891,6 +4047,7 @@ For more information about transactional templates, please see our [User Guide](
### GET /templates/{template_id}/versions/{version_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -3917,6 +4074,7 @@ For more information about transactional templates, please see our [User Guide](
### DELETE /templates/{template_id}/versions/{version_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -3944,6 +4102,7 @@ For more information about transactional templates, please see our [User Guide](
### POST /templates/{template_id}/versions/{version_id}/activate
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -3967,6 +4126,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### GET /tracking_settings
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
@@ -3989,6 +4149,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### PATCH /tracking_settings/click
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4012,6 +4173,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### GET /tracking_settings/click
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4036,14 +4198,15 @@ For more information about tracking, please see our [User Guide](https://sendgri
### PATCH /tracking_settings/google_analytics
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
- "utm_campaign": "website",
- "utm_content": "",
- "utm_medium": "email",
- "utm_source": "sendgrid.com",
+ "enabled": true,
+ "utm_campaign": "website",
+ "utm_content": "",
+ "utm_medium": "email",
+ "utm_source": "sendgrid.com",
"utm_term": ""
};
request.method = 'PATCH'
@@ -4068,6 +4231,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### GET /tracking_settings/google_analytics
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4090,6 +4254,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### PATCH /tracking_settings/open
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4115,6 +4280,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### GET /tracking_settings/open
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4137,14 +4303,15 @@ For more information about tracking, please see our [User Guide](https://sendgri
### PATCH /tracking_settings/subscription
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "enabled": true,
- "html_content": "html content",
- "landing": "landing page html",
- "plain_content": "text content",
- "replace": "replacement tag",
+ "enabled": true,
+ "html_content": "html content",
+ "landing": "landing page html",
+ "plain_content": "text content",
+ "replace": "replacement tag",
"url": "url"
};
request.method = 'PATCH'
@@ -4167,6 +4334,7 @@ For more information about tracking, please see our [User Guide](https://sendgri
### GET /tracking_settings/subscription
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4194,6 +4362,7 @@ For more information about your user profile:
### GET /user/account
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4212,6 +4381,7 @@ Your monthly credit allotment limits the number of emails you may send before in
### GET /user/credits
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4234,6 +4404,7 @@ For more information about your user profile:
### PUT /user/email
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4259,6 +4430,7 @@ For more information about your user profile:
### GET /user/email
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4281,10 +4453,11 @@ For more information about your user profile:
### PUT /user/password
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "new_password": "new_password",
+ "new_password": "new_password",
"old_password": "old_password"
};
request.method = 'PUT'
@@ -4309,11 +4482,12 @@ It should be noted that any one or more of the parameters can be updated via the
### PATCH /user/profile
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "city": "Orange",
- "first_name": "Example",
+ "city": "Orange",
+ "first_name": "Example",
"last_name": "User"
};
request.method = 'PATCH'
@@ -4334,6 +4508,7 @@ For more information about your user profile:
### GET /user/profile
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4355,10 +4530,11 @@ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled sen
### POST /user/scheduled_sends
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "batch_id": "YOUR_BATCH_ID",
+ "batch_id": "YOUR_BATCH_ID",
"status": "pause"
};
request.method = 'POST'
@@ -4377,6 +4553,7 @@ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled sen
### GET /user/scheduled_sends
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4395,6 +4572,7 @@ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled sen
### PATCH /user/scheduled_sends/{batch_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4416,6 +4594,7 @@ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled sen
### GET /user/scheduled_sends/{batch_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4434,6 +4613,7 @@ The Cancel Scheduled Sends feature allows the customer to cancel a scheduled sen
### DELETE /user/scheduled_sends/{batch_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -4454,10 +4634,11 @@ The Enforced TLS settings specify whether or not the recipient is required to su
### PATCH /user/settings/enforced_tls
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "require_tls": true,
+ "require_tls": true,
"require_valid_cert": false
};
request.method = 'PATCH'
@@ -4478,6 +4659,7 @@ The Enforced TLS settings specify whether or not the recipient is required to su
### GET /user/settings/enforced_tls
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4500,6 +4682,7 @@ For more information about your user profile:
### PUT /user/username
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4525,6 +4708,7 @@ For more information about your user profile:
### GET /user/username
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4547,21 +4731,22 @@ Common uses of this data are to remove unsubscribes, react to spam reports, dete
### PATCH /user/webhooks/event/settings
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "bounce": true,
- "click": true,
- "deferred": true,
- "delivered": true,
- "dropped": true,
- "enabled": true,
- "group_resubscribe": true,
- "group_unsubscribe": true,
- "open": true,
- "processed": true,
- "spam_report": true,
- "unsubscribe": true,
+ "bounce": true,
+ "click": true,
+ "deferred": true,
+ "delivered": true,
+ "dropped": true,
+ "enabled": true,
+ "group_resubscribe": true,
+ "group_unsubscribe": true,
+ "open": true,
+ "processed": true,
+ "spam_report": true,
+ "unsubscribe": true,
"url": "url"
};
request.method = 'PATCH'
@@ -4584,6 +4769,7 @@ Common uses of this data are to remove unsubscribes, react to spam reports, dete
### GET /user/webhooks/event/settings
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4594,7 +4780,7 @@ Common uses of this data are to remove unsubscribes, react to spam reports, dete
console.log(response.headers)
})
```
-## Test Event Notification Settings
+## Test Event Notification Settings
**This endpoint allows you to test your event webhook by sending a fake event notification post to the provided URL.**
@@ -4604,6 +4790,7 @@ Common uses of this data are to remove unsubscribes, react to spam reports, dete
### POST /user/webhooks/event/test
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4625,6 +4812,7 @@ SendGrid can parse the attachments and contents of incoming emails. The Parse AP
### GET /user/webhooks/parse/settings
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4645,6 +4833,7 @@ There are a number of pre-made integrations for the SendGrid Parse Webhook which
### GET /user/webhooks/parse/stats
+
```javascript
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
@@ -4677,18 +4866,19 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### POST /whitelabel/domains
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "automatic_security": false,
- "custom_spf": true,
- "default": true,
- "domain": "example.com",
+ "automatic_security": false,
+ "custom_spf": true,
+ "default": true,
+ "domain": "example.com",
"ips": [
- "192.168.1.1",
+ "192.168.1.1",
"192.168.1.2"
- ],
- "subdomain": "news",
+ ],
+ "subdomain": "news",
"username": "john@example.com"
};
request.method = 'POST'
@@ -4710,6 +4900,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### GET /whitelabel/domains
+
```javascript
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
@@ -4740,6 +4931,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### GET /whitelabel/domains/default
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4767,6 +4959,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### GET /whitelabel/domains/subuser
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4794,6 +4987,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### DELETE /whitelabel/domains/subuser
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -4814,10 +5008,11 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### PATCH /whitelabel/domains/{domain_id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "custom_spf": true,
+ "custom_spf": true,
"default": false
};
request.method = 'PATCH'
@@ -4839,6 +5034,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### GET /whitelabel/domains/{domain_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -4859,6 +5055,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### DELETE /whitelabel/domains/{domain_id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -4886,6 +5083,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### POST /whitelabel/domains/{domain_id}/subuser
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4914,6 +5112,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### POST /whitelabel/domains/{id}/ips
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -4943,6 +5142,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### DELETE /whitelabel/domains/{id}/ips/{ip}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -4968,6 +5168,7 @@ For more information on whitelabeling, please see our [User Guide](https://sendg
### POST /whitelabel/domains/{id}/validate
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -4990,11 +5191,12 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### POST /whitelabel/ips
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "domain": "example.com",
- "ip": "192.168.1.1",
+ "domain": "example.com",
+ "ip": "192.168.1.1",
"subdomain": "email"
};
request.method = 'POST'
@@ -5017,6 +5219,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/ips
+
```javascript
var request = sg.emptyRequest()
request.queryParams["ip"] = 'test_string'
@@ -5040,6 +5243,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/ips/{id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -5060,6 +5264,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### DELETE /whitelabel/ips/{id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -5080,6 +5285,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### POST /whitelabel/ips/{id}/validate
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -5100,11 +5306,12 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### POST /whitelabel/links
+
```javascript
var request = sg.emptyRequest()
request.body = {
- "default": true,
- "domain": "example.com",
+ "default": true,
+ "domain": "example.com",
"subdomain": "mail"
};
request.queryParams["limit"] = '1'
@@ -5127,6 +5334,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/links
+
```javascript
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
@@ -5155,6 +5363,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/links/default
+
```javascript
var request = sg.emptyRequest()
request.queryParams["domain"] = 'test_string'
@@ -5180,6 +5389,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/links/subuser
+
```javascript
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
@@ -5205,6 +5415,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### DELETE /whitelabel/links/subuser
+
```javascript
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
@@ -5226,6 +5437,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### PATCH /whitelabel/links/{id}
+
```javascript
var request = sg.emptyRequest()
request.body = {
@@ -5249,6 +5461,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### GET /whitelabel/links/{id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'GET'
@@ -5269,6 +5482,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### DELETE /whitelabel/links/{id}
+
```javascript
var request = sg.emptyRequest()
request.method = 'DELETE'
@@ -5289,6 +5503,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### POST /whitelabel/links/{id}/validate
+
```javascript
var request = sg.emptyRequest()
request.method = 'POST'
@@ -5313,6 +5528,7 @@ For more information, please see our [User Guide](https://sendgrid.com/docs/API_
### POST /whitelabel/links/{link_id}/subuser
+
```javascript
var request = sg.emptyRequest()
request.body = {
diff --git a/examples/accesssettings/accesssettings.js b/examples/accesssettings/accesssettings.js
index f29ade6..d8364fa 100644
--- a/examples/accesssettings/accesssettings.js
+++ b/examples/accesssettings/accesssettings.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve all recent access attempts
// GET /access_settings/activity
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
request.method = 'GET'
@@ -18,6 +19,7 @@ sg.API(request, function (response) {
// Add one or more IPs to the whitelist
// POST /access_settings/whitelist
+
var request = sg.emptyRequest()
request.body = {
"ips": [
@@ -44,6 +46,7 @@ sg.API(request, function (response) {
// Retrieve a list of currently whitelisted IPs
// GET /access_settings/whitelist
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/access_settings/whitelist'
@@ -57,6 +60,7 @@ sg.API(request, function (response) {
// Remove one or more IPs from the whitelist
// DELETE /access_settings/whitelist
+
var request = sg.emptyRequest()
request.body = {
"ids": [
@@ -77,6 +81,7 @@ sg.API(request, function (response) {
// Retrieve a specific whitelisted IP
// GET /access_settings/whitelist/{rule_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/access_settings/whitelist/{rule_id}'
@@ -90,6 +95,7 @@ sg.API(request, function (response) {
// Remove a specific IP from the whitelist
// DELETE /access_settings/whitelist/{rule_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/access_settings/whitelist/{rule_id}'
diff --git a/examples/apikeys/apikeys.js b/examples/apikeys/apikeys.js
index a0481a8..3eb2ea2 100644
--- a/examples/apikeys/apikeys.js
+++ b/examples/apikeys/apikeys.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create API keys
// POST /api_keys
+
var request = sg.emptyRequest()
request.body = {
"name": "My API Key",
@@ -25,6 +26,7 @@ sg.API(request, function (response) {
// Retrieve all API Keys belonging to the authenticated user
// GET /api_keys
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/api_keys'
@@ -38,6 +40,7 @@ sg.API(request, function (response) {
// Update the name & scopes of an API Key
// PUT /api_keys/{api_key_id}
+
var request = sg.emptyRequest()
request.body = {
"name": "A New Hope",
@@ -58,6 +61,7 @@ sg.API(request, function (response) {
// Update API keys
// PATCH /api_keys/{api_key_id}
+
var request = sg.emptyRequest()
request.body = {
"name": "A New Hope"
@@ -74,6 +78,7 @@ sg.API(request, function (response) {
// Retrieve an existing API Key
// GET /api_keys/{api_key_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/api_keys/{api_key_id}'
@@ -87,6 +92,7 @@ sg.API(request, function (response) {
// Delete API keys
// DELETE /api_keys/{api_key_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/api_keys/{api_key_id}'
diff --git a/examples/asm/asm.js b/examples/asm/asm.js
index 659f6ae..1f3bbc9 100644
--- a/examples/asm/asm.js
+++ b/examples/asm/asm.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a new suppression group
// POST /asm/groups
+
var request = sg.emptyRequest()
request.body = {
"description": "Suggestions for products our users might like.",
@@ -22,6 +23,7 @@ sg.API(request, function (response) {
// Retrieve information about multiple suppression groups
// GET /asm/groups
+
var request = sg.emptyRequest()
request.queryParams["id"] = '1'
request.method = 'GET'
@@ -36,6 +38,7 @@ sg.API(request, function (response) {
// Update a suppression group.
// PATCH /asm/groups/{group_id}
+
var request = sg.emptyRequest()
request.body = {
"description": "Suggestions for items our users might like.",
@@ -54,6 +57,7 @@ sg.API(request, function (response) {
// Get information on a single suppression group.
// GET /asm/groups/{group_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/asm/groups/{group_id}'
@@ -67,6 +71,7 @@ sg.API(request, function (response) {
// Delete a suppression group.
// DELETE /asm/groups/{group_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/asm/groups/{group_id}'
@@ -80,6 +85,7 @@ sg.API(request, function (response) {
// Add suppressions to a suppression group
// POST /asm/groups/{group_id}/suppressions
+
var request = sg.emptyRequest()
request.body = {
"recipient_emails": [
@@ -99,6 +105,7 @@ sg.API(request, function (response) {
// Retrieve all suppressions for a suppression group
// GET /asm/groups/{group_id}/suppressions
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/asm/groups/{group_id}/suppressions'
@@ -112,6 +119,7 @@ sg.API(request, function (response) {
// Delete a suppression from a suppression group
// DELETE /asm/groups/{group_id}/suppressions/{email}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/asm/groups/{group_id}/suppressions/{email}'
@@ -125,6 +133,7 @@ sg.API(request, function (response) {
// Retrieve all suppressions
// GET /asm/suppressions
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/asm/suppressions'
@@ -138,6 +147,7 @@ sg.API(request, function (response) {
// Add recipient addresses to the global suppression group.
// POST /asm/suppressions/global
+
var request = sg.emptyRequest()
request.body = {
"recipient_emails": [
@@ -157,6 +167,7 @@ sg.API(request, function (response) {
// Retrieve a Global Suppression
// GET /asm/suppressions/global/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/asm/suppressions/global/{email}'
@@ -170,6 +181,7 @@ sg.API(request, function (response) {
// Delete a Global Suppression
// DELETE /asm/suppressions/global/{email}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/asm/suppressions/global/{email}'
@@ -183,6 +195,7 @@ sg.API(request, function (response) {
// Retrieve all suppression groups for an email address
// GET /asm/suppressions/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/asm/suppressions/{email}'
diff --git a/examples/browsers/browsers.js b/examples/browsers/browsers.js
index 7d50a46..04046c3 100644
--- a/examples/browsers/browsers.js
+++ b/examples/browsers/browsers.js
@@ -4,13 +4,14 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve email statistics by browser.
// GET /browsers/stats
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["browsers"] = 'test_string'
- request.queryParams["limit"] = 'test_string'
- request.queryParams["offset"] = 'test_string'
- request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["browsers"] = 'test_string'
+request.queryParams["limit"] = 'test_string'
+request.queryParams["offset"] = 'test_string'
+request.queryParams["start_date"] = '2016-01-01'
request.method = 'GET'
request.path = '/v3/browsers/stats'
sg.API(request, function (response) {
diff --git a/examples/campaigns/campaigns.js b/examples/campaigns/campaigns.js
index ceb8122..821c3db 100644
--- a/examples/campaigns/campaigns.js
+++ b/examples/campaigns/campaigns.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a Campaign
// POST /campaigns
+
var request = sg.emptyRequest()
request.body = {
"categories": [
@@ -37,9 +38,10 @@ sg.API(request, function (response) {
// Retrieve all Campaigns
// GET /campaigns
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '0'
- request.queryParams["offset"] = '0'
+request.queryParams["offset"] = '0'
request.method = 'GET'
request.path = '/v3/campaigns'
sg.API(request, function (response) {
@@ -52,6 +54,7 @@ sg.API(request, function (response) {
// Update a Campaign
// PATCH /campaigns/{campaign_id}
+
var request = sg.emptyRequest()
request.body = {
"categories": [
@@ -74,6 +77,7 @@ sg.API(request, function (response) {
// Retrieve a single campaign
// GET /campaigns/{campaign_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/campaigns/{campaign_id}'
@@ -87,6 +91,7 @@ sg.API(request, function (response) {
// Delete a Campaign
// DELETE /campaigns/{campaign_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/campaigns/{campaign_id}'
@@ -100,6 +105,7 @@ sg.API(request, function (response) {
// Update a Scheduled Campaign
// PATCH /campaigns/{campaign_id}/schedules
+
var request = sg.emptyRequest()
request.body = {
"send_at": 1489451436
@@ -116,6 +122,7 @@ sg.API(request, function (response) {
// Schedule a Campaign
// POST /campaigns/{campaign_id}/schedules
+
var request = sg.emptyRequest()
request.body = {
"send_at": 1489771528
@@ -132,6 +139,7 @@ sg.API(request, function (response) {
// View Scheduled Time of a Campaign
// GET /campaigns/{campaign_id}/schedules
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/campaigns/{campaign_id}/schedules'
@@ -145,6 +153,7 @@ sg.API(request, function (response) {
// Unschedule a Scheduled Campaign
// DELETE /campaigns/{campaign_id}/schedules
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/campaigns/{campaign_id}/schedules'
@@ -158,6 +167,7 @@ sg.API(request, function (response) {
// Send a Campaign
// POST /campaigns/{campaign_id}/schedules/now
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/campaigns/{campaign_id}/schedules/now'
@@ -171,6 +181,7 @@ sg.API(request, function (response) {
// Send a Test Campaign
// POST /campaigns/{campaign_id}/schedules/test
+
var request = sg.emptyRequest()
request.body = {
"to": "your.email@example.com"
diff --git a/examples/categories/categories.js b/examples/categories/categories.js
index 9326585..04e8579 100644
--- a/examples/categories/categories.js
+++ b/examples/categories/categories.js
@@ -4,10 +4,11 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve all categories
// GET /categories
+
var request = sg.emptyRequest()
request.queryParams["category"] = 'test_string'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/categories'
sg.API(request, function (response) {
@@ -20,13 +21,14 @@ sg.API(request, function (response) {
// Retrieve Email Statistics for Categories
// GET /categories/stats
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["categories"] = 'test_string'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["categories"] = 'test_string'
request.method = 'GET'
request.path = '/v3/categories/stats'
sg.API(request, function (response) {
@@ -39,14 +41,15 @@ sg.API(request, function (response) {
// Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?]
// GET /categories/stats/sums
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["sort_by_metric"] = 'test_string'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["sort_by_direction"] = 'asc'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["sort_by_metric"] = 'test_string'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["sort_by_direction"] = 'asc'
request.method = 'GET'
request.path = '/v3/categories/stats/sums'
sg.API(request, function (response) {
diff --git a/examples/clients/clients.js b/examples/clients/clients.js
index 0e12bba..d018a81 100644
--- a/examples/clients/clients.js
+++ b/examples/clients/clients.js
@@ -4,10 +4,11 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve email statistics by client type.
// GET /clients/stats
+
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["end_date"] = '2016-04-01'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["end_date"] = '2016-04-01'
request.method = 'GET'
request.path = '/v3/clients/stats'
sg.API(request, function (response) {
@@ -20,10 +21,11 @@ sg.API(request, function (response) {
// Retrieve stats by a specific client type.
// GET /clients/{client_type}/stats
+
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["end_date"] = '2016-04-01'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["end_date"] = '2016-04-01'
request.method = 'GET'
request.path = '/v3/clients/{client_type}/stats'
sg.API(request, function (response) {
diff --git a/examples/contactdb/contactdb.js b/examples/contactdb/contactdb.js
index 7c6a8a1..f2139b5 100644
--- a/examples/contactdb/contactdb.js
+++ b/examples/contactdb/contactdb.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a Custom Field
// POST /contactdb/custom_fields
+
var request = sg.emptyRequest()
request.body = {
"name": "pet",
@@ -21,6 +22,7 @@ sg.API(request, function (response) {
// Retrieve all custom fields
// GET /contactdb/custom_fields
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/custom_fields'
@@ -34,6 +36,7 @@ sg.API(request, function (response) {
// Retrieve a Custom Field
// GET /contactdb/custom_fields/{custom_field_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/custom_fields/{custom_field_id}'
@@ -47,6 +50,7 @@ sg.API(request, function (response) {
// Delete a Custom Field
// DELETE /contactdb/custom_fields/{custom_field_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/contactdb/custom_fields/{custom_field_id}'
@@ -60,6 +64,7 @@ sg.API(request, function (response) {
// Create a List
// POST /contactdb/lists
+
var request = sg.emptyRequest()
request.body = {
"name": "your list name"
@@ -76,6 +81,7 @@ sg.API(request, function (response) {
// Retrieve all lists
// GET /contactdb/lists
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/lists'
@@ -89,6 +95,7 @@ sg.API(request, function (response) {
// Delete Multiple lists
// DELETE /contactdb/lists
+
var request = sg.emptyRequest()
request.body = [
1,
@@ -108,6 +115,7 @@ sg.API(request, function (response) {
// Update a List
// PATCH /contactdb/lists/{list_id}
+
var request = sg.emptyRequest()
request.body = {
"name": "newlistname"
@@ -125,6 +133,7 @@ sg.API(request, function (response) {
// Retrieve a single list
// GET /contactdb/lists/{list_id}
+
var request = sg.emptyRequest()
request.queryParams["list_id"] = '0'
request.method = 'GET'
@@ -139,6 +148,7 @@ sg.API(request, function (response) {
// Delete a List
// DELETE /contactdb/lists/{list_id}
+
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
request.method = 'DELETE'
@@ -153,6 +163,7 @@ sg.API(request, function (response) {
// Add Multiple Recipients to a List
// POST /contactdb/lists/{list_id}/recipients
+
var request = sg.emptyRequest()
request.body = [
"recipient_id1",
@@ -170,10 +181,11 @@ sg.API(request, function (response) {
// Retrieve all recipients on a List
// GET /contactdb/lists/{list_id}/recipients
+
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
- request.queryParams["page_size"] = '1'
- request.queryParams["list_id"] = '0'
+request.queryParams["page_size"] = '1'
+request.queryParams["list_id"] = '0'
request.method = 'GET'
request.path = '/v3/contactdb/lists/{list_id}/recipients'
sg.API(request, function (response) {
@@ -186,6 +198,7 @@ sg.API(request, function (response) {
// Add a Single Recipient to a List
// POST /contactdb/lists/{list_id}/recipients/{recipient_id}
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'
@@ -199,9 +212,10 @@ sg.API(request, function (response) {
// Delete a Single Recipient from a Single List
// DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}
+
var request = sg.emptyRequest()
request.queryParams["recipient_id"] = '0'
- request.queryParams["list_id"] = '0'
+request.queryParams["list_id"] = '0'
request.method = 'DELETE'
request.path = '/v3/contactdb/lists/{list_id}/recipients/{recipient_id}'
sg.API(request, function (response) {
@@ -214,6 +228,7 @@ sg.API(request, function (response) {
// Update Recipient
// PATCH /contactdb/recipients
+
var request = sg.emptyRequest()
request.body = [
{
@@ -234,6 +249,7 @@ sg.API(request, function (response) {
// Add recipients
// POST /contactdb/recipients
+
var request = sg.emptyRequest()
request.body = [
{
@@ -261,9 +277,10 @@ sg.API(request, function (response) {
// Retrieve recipients
// GET /contactdb/recipients
+
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
- request.queryParams["page_size"] = '1'
+request.queryParams["page_size"] = '1'
request.method = 'GET'
request.path = '/v3/contactdb/recipients'
sg.API(request, function (response) {
@@ -276,6 +293,7 @@ sg.API(request, function (response) {
// Delete Recipient
// DELETE /contactdb/recipients
+
var request = sg.emptyRequest()
request.body = [
"recipient_id1",
@@ -293,6 +311,7 @@ sg.API(request, function (response) {
// Retrieve the count of billable recipients
// GET /contactdb/recipients/billable_count
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/recipients/billable_count'
@@ -306,6 +325,7 @@ sg.API(request, function (response) {
// Retrieve a Count of Recipients
// GET /contactdb/recipients/count
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/recipients/count'
@@ -319,6 +339,7 @@ sg.API(request, function (response) {
// Retrieve recipients matching search criteria
// GET /contactdb/recipients/search
+
var request = sg.emptyRequest()
request.queryParams["{field_name}"] = 'test_string'
request.method = 'GET'
@@ -333,6 +354,7 @@ sg.API(request, function (response) {
// Retrieve a single recipient
// GET /contactdb/recipients/{recipient_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/recipients/{recipient_id}'
@@ -346,6 +368,7 @@ sg.API(request, function (response) {
// Delete a Recipient
// DELETE /contactdb/recipients/{recipient_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/contactdb/recipients/{recipient_id}'
@@ -359,6 +382,7 @@ sg.API(request, function (response) {
// Retrieve the lists that a recipient is on
// GET /contactdb/recipients/{recipient_id}/lists
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/recipients/{recipient_id}/lists'
@@ -372,6 +396,7 @@ sg.API(request, function (response) {
// Retrieve reserved fields
// GET /contactdb/reserved_fields
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/reserved_fields'
@@ -385,6 +410,7 @@ sg.API(request, function (response) {
// Create a Segment
// POST /contactdb/segments
+
var request = sg.emptyRequest()
request.body = {
"conditions": [
@@ -422,6 +448,7 @@ sg.API(request, function (response) {
// Retrieve all segments
// GET /contactdb/segments
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/contactdb/segments'
@@ -435,6 +462,7 @@ sg.API(request, function (response) {
// Update a segment
// PATCH /contactdb/segments/{segment_id}
+
var request = sg.emptyRequest()
request.body = {
"conditions": [
@@ -461,6 +489,7 @@ sg.API(request, function (response) {
// Retrieve a segment
// GET /contactdb/segments/{segment_id}
+
var request = sg.emptyRequest()
request.queryParams["segment_id"] = '0'
request.method = 'GET'
@@ -475,6 +504,7 @@ sg.API(request, function (response) {
// Delete a segment
// DELETE /contactdb/segments/{segment_id}
+
var request = sg.emptyRequest()
request.queryParams["delete_contacts"] = 'true'
request.method = 'DELETE'
@@ -489,9 +519,10 @@ sg.API(request, function (response) {
// Retrieve recipients on a segment
// GET /contactdb/segments/{segment_id}/recipients
+
var request = sg.emptyRequest()
request.queryParams["page"] = '1'
- request.queryParams["page_size"] = '1'
+request.queryParams["page_size"] = '1'
request.method = 'GET'
request.path = '/v3/contactdb/segments/{segment_id}/recipients'
sg.API(request, function (response) {
diff --git a/examples/devices/devices.js b/examples/devices/devices.js
index f7f8b67..a41a102 100644
--- a/examples/devices/devices.js
+++ b/examples/devices/devices.js
@@ -4,12 +4,13 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve email statistics by device type.
// GET /devices/stats
+
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["end_date"] = '2016-04-01'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/devices/stats'
sg.API(request, function (response) {
diff --git a/examples/geo/geo.js b/examples/geo/geo.js
index 8a44677..4389d92 100644
--- a/examples/geo/geo.js
+++ b/examples/geo/geo.js
@@ -4,13 +4,14 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve email statistics by country and state/province.
// GET /geo/stats
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["country"] = 'US'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["country"] = 'US'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
request.method = 'GET'
request.path = '/v3/geo/stats'
sg.API(request, function (response) {
diff --git a/examples/ips/ips.js b/examples/ips/ips.js
index 14147d5..cb4d0fb 100644
--- a/examples/ips/ips.js
+++ b/examples/ips/ips.js
@@ -4,12 +4,13 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve all IP addresses
// GET /ips
+
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
- request.queryParams["ip"] = 'test_string'
- request.queryParams["limit"] = '1'
- request.queryParams["exclude_whitelabels"] = 'true'
- request.queryParams["offset"] = '1'
+request.queryParams["ip"] = 'test_string'
+request.queryParams["limit"] = '1'
+request.queryParams["exclude_whitelabels"] = 'true'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/ips'
sg.API(request, function (response) {
@@ -22,6 +23,7 @@ sg.API(request, function (response) {
// Retrieve all assigned IPs
// GET /ips/assigned
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/assigned'
@@ -35,6 +37,7 @@ sg.API(request, function (response) {
// Create an IP pool.
// POST /ips/pools
+
var request = sg.emptyRequest()
request.body = {
"name": "marketing"
@@ -51,6 +54,7 @@ sg.API(request, function (response) {
// Retrieve all IP pools.
// GET /ips/pools
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/pools'
@@ -64,6 +68,7 @@ sg.API(request, function (response) {
// Update an IP pools name.
// PUT /ips/pools/{pool_name}
+
var request = sg.emptyRequest()
request.body = {
"name": "new_pool_name"
@@ -80,6 +85,7 @@ sg.API(request, function (response) {
// Retrieve all IPs in a specified pool.
// GET /ips/pools/{pool_name}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/pools/{pool_name}'
@@ -93,6 +99,7 @@ sg.API(request, function (response) {
// Delete an IP pool.
// DELETE /ips/pools/{pool_name}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/ips/pools/{pool_name}'
@@ -106,6 +113,7 @@ sg.API(request, function (response) {
// Add an IP address to a pool
// POST /ips/pools/{pool_name}/ips
+
var request = sg.emptyRequest()
request.body = {
"ip": "0.0.0.0"
@@ -122,6 +130,7 @@ sg.API(request, function (response) {
// Remove an IP address from a pool.
// DELETE /ips/pools/{pool_name}/ips/{ip}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/ips/pools/{pool_name}/ips/{ip}'
@@ -135,6 +144,7 @@ sg.API(request, function (response) {
// Add an IP to warmup
// POST /ips/warmup
+
var request = sg.emptyRequest()
request.body = {
"ip": "0.0.0.0"
@@ -151,6 +161,7 @@ sg.API(request, function (response) {
// Retrieve all IPs currently in warmup
// GET /ips/warmup
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/warmup'
@@ -164,6 +175,7 @@ sg.API(request, function (response) {
// Retrieve warmup status for a specific IP address
// GET /ips/warmup/{ip_address}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/warmup/{ip_address}'
@@ -177,6 +189,7 @@ sg.API(request, function (response) {
// Remove an IP from warmup
// DELETE /ips/warmup/{ip_address}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/ips/warmup/{ip_address}'
@@ -190,6 +203,7 @@ sg.API(request, function (response) {
// Retrieve all IP pools an IP address belongs to
// GET /ips/{ip_address}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/ips/{ip_address}'
diff --git a/examples/mail/mail.js b/examples/mail/mail.js
index e6e6491..009f10e 100644
--- a/examples/mail/mail.js
+++ b/examples/mail/mail.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a batch ID
// POST /mail/batch
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/mail/batch'
@@ -17,6 +18,7 @@ sg.API(request, function (response) {
// Validate batch ID
// GET /mail/batch/{batch_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail/batch/{batch_id}'
@@ -30,6 +32,8 @@ sg.API(request, function (response) {
// v3 Mail Send Beta
// POST /mail/send/beta
+// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/blob/v3beta/lib/helpers/mail/README.md).
+
var request = sg.emptyRequest()
request.body = {
"asm": {
diff --git a/examples/mailboxproviders/mailboxproviders.js b/examples/mailboxproviders/mailboxproviders.js
index 6b87f7e..18779a1 100644
--- a/examples/mailboxproviders/mailboxproviders.js
+++ b/examples/mailboxproviders/mailboxproviders.js
@@ -4,13 +4,14 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve email statistics by mailbox provider.
// GET /mailbox_providers/stats
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["mailbox_providers"] = 'test_string'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["mailbox_providers"] = 'test_string'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
request.method = 'GET'
request.path = '/v3/mailbox_providers/stats'
sg.API(request, function (response) {
diff --git a/examples/mailsettings/mailsettings.js b/examples/mailsettings/mailsettings.js
index 23fbc49..2c7cc80 100644
--- a/examples/mailsettings/mailsettings.js
+++ b/examples/mailsettings/mailsettings.js
@@ -4,9 +4,10 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve all mail settings
// GET /mail_settings
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/mail_settings'
sg.API(request, function (response) {
@@ -19,6 +20,7 @@ sg.API(request, function (response) {
// Update address whitelist mail settings
// PATCH /mail_settings/address_whitelist
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -39,6 +41,7 @@ sg.API(request, function (response) {
// Retrieve address whitelist mail settings
// GET /mail_settings/address_whitelist
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/address_whitelist'
@@ -52,6 +55,7 @@ sg.API(request, function (response) {
// Update BCC mail settings
// PATCH /mail_settings/bcc
+
var request = sg.emptyRequest()
request.body = {
"email": "email@example.com",
@@ -69,6 +73,7 @@ sg.API(request, function (response) {
// Retrieve all BCC mail settings
// GET /mail_settings/bcc
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/bcc'
@@ -82,6 +87,7 @@ sg.API(request, function (response) {
// Update bounce purge mail settings
// PATCH /mail_settings/bounce_purge
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -100,6 +106,7 @@ sg.API(request, function (response) {
// Retrieve bounce purge mail settings
// GET /mail_settings/bounce_purge
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/bounce_purge'
@@ -113,6 +120,7 @@ sg.API(request, function (response) {
// Update footer mail settings
// PATCH /mail_settings/footer
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -131,6 +139,7 @@ sg.API(request, function (response) {
// Retrieve footer mail settings
// GET /mail_settings/footer
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/footer'
@@ -144,6 +153,7 @@ sg.API(request, function (response) {
// Update forward bounce mail settings
// PATCH /mail_settings/forward_bounce
+
var request = sg.emptyRequest()
request.body = {
"email": "example@example.com",
@@ -161,6 +171,7 @@ sg.API(request, function (response) {
// Retrieve forward bounce mail settings
// GET /mail_settings/forward_bounce
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/forward_bounce'
@@ -174,6 +185,7 @@ sg.API(request, function (response) {
// Update forward spam mail settings
// PATCH /mail_settings/forward_spam
+
var request = sg.emptyRequest()
request.body = {
"email": "",
@@ -191,6 +203,7 @@ sg.API(request, function (response) {
// Retrieve forward spam mail settings
// GET /mail_settings/forward_spam
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/forward_spam'
@@ -204,6 +217,7 @@ sg.API(request, function (response) {
// Update plain content mail settings
// PATCH /mail_settings/plain_content
+
var request = sg.emptyRequest()
request.body = {
"enabled": false
@@ -220,6 +234,7 @@ sg.API(request, function (response) {
// Retrieve plain content mail settings
// GET /mail_settings/plain_content
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/plain_content'
@@ -233,6 +248,7 @@ sg.API(request, function (response) {
// Update spam check mail settings
// PATCH /mail_settings/spam_check
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -251,6 +267,7 @@ sg.API(request, function (response) {
// Retrieve spam check mail settings
// GET /mail_settings/spam_check
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/spam_check'
@@ -264,6 +281,7 @@ sg.API(request, function (response) {
// Update template mail settings
// PATCH /mail_settings/template
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -281,6 +299,7 @@ sg.API(request, function (response) {
// Retrieve legacy template mail settings
// GET /mail_settings/template
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/mail_settings/template'
diff --git a/examples/partnersettings/partnersettings.js b/examples/partnersettings/partnersettings.js
index 45ea239..945785b 100644
--- a/examples/partnersettings/partnersettings.js
+++ b/examples/partnersettings/partnersettings.js
@@ -4,9 +4,10 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Returns a list of all partner settings.
// GET /partner_settings
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/partner_settings'
sg.API(request, function (response) {
@@ -19,6 +20,7 @@ sg.API(request, function (response) {
// Updates New Relic partner settings.
// PATCH /partner_settings/new_relic
+
var request = sg.emptyRequest()
request.body = {
"enable_subuser_statistics": true,
@@ -37,6 +39,7 @@ sg.API(request, function (response) {
// Returns all New Relic partner settings.
// GET /partner_settings/new_relic
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/partner_settings/new_relic'
diff --git a/examples/scopes/scopes.js b/examples/scopes/scopes.js
index 6c42f3d..2a7e2a0 100644
--- a/examples/scopes/scopes.js
+++ b/examples/scopes/scopes.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve a list of scopes for which this user has access.
// GET /scopes
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/scopes'
diff --git a/examples/stats/stats.js b/examples/stats/stats.js
index 4e2f8e1..c57b19d 100644
--- a/examples/stats/stats.js
+++ b/examples/stats/stats.js
@@ -4,12 +4,13 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve global email statistics
// GET /stats
+
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["end_date"] = '2016-04-01'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/stats'
sg.API(request, function (response) {
diff --git a/examples/subusers/subusers.js b/examples/subusers/subusers.js
index 4b7f336..d075988 100644
--- a/examples/subusers/subusers.js
+++ b/examples/subusers/subusers.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create Subuser
// POST /subusers
+
var request = sg.emptyRequest()
request.body = {
"email": "John@example.com",
@@ -26,10 +27,11 @@ sg.API(request, function (response) {
// List all Subusers
// GET /subusers
+
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
- request.queryParams["limit"] = '0'
- request.queryParams["offset"] = '0'
+request.queryParams["limit"] = '0'
+request.queryParams["offset"] = '0'
request.method = 'GET'
request.path = '/v3/subusers'
sg.API(request, function (response) {
@@ -42,6 +44,7 @@ sg.API(request, function (response) {
// Retrieve Subuser Reputations
// GET /subusers/reputations
+
var request = sg.emptyRequest()
request.queryParams["usernames"] = 'test_string'
request.method = 'GET'
@@ -56,13 +59,14 @@ sg.API(request, function (response) {
// Retrieve email statistics for your subusers.
// GET /subusers/stats
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["subusers"] = 'test_string'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["subusers"] = 'test_string'
request.method = 'GET'
request.path = '/v3/subusers/stats'
sg.API(request, function (response) {
@@ -75,13 +79,14 @@ sg.API(request, function (response) {
// Retrieve monthly stats for all subusers
// GET /subusers/stats/monthly
+
var request = sg.emptyRequest()
request.queryParams["subuser"] = 'test_string'
- request.queryParams["limit"] = '1'
- request.queryParams["sort_by_metric"] = 'test_string'
- request.queryParams["offset"] = '1'
- request.queryParams["date"] = 'test_string'
- request.queryParams["sort_by_direction"] = 'asc'
+request.queryParams["limit"] = '1'
+request.queryParams["sort_by_metric"] = 'test_string'
+request.queryParams["offset"] = '1'
+request.queryParams["date"] = 'test_string'
+request.queryParams["sort_by_direction"] = 'asc'
request.method = 'GET'
request.path = '/v3/subusers/stats/monthly'
sg.API(request, function (response) {
@@ -94,14 +99,15 @@ sg.API(request, function (response) {
// Retrieve the totals for each email statistic metric for all subusers.
// GET /subusers/stats/sums
+
var request = sg.emptyRequest()
request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = '1'
- request.queryParams["sort_by_metric"] = 'test_string'
- request.queryParams["offset"] = '1'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["sort_by_direction"] = 'asc'
+request.queryParams["aggregated_by"] = 'day'
+request.queryParams["limit"] = '1'
+request.queryParams["sort_by_metric"] = 'test_string'
+request.queryParams["offset"] = '1'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["sort_by_direction"] = 'asc'
request.method = 'GET'
request.path = '/v3/subusers/stats/sums'
sg.API(request, function (response) {
@@ -114,6 +120,7 @@ sg.API(request, function (response) {
// Enable/disable a subuser
// PATCH /subusers/{subuser_name}
+
var request = sg.emptyRequest()
request.body = {
"disabled": false
@@ -130,6 +137,7 @@ sg.API(request, function (response) {
// Delete a subuser
// DELETE /subusers/{subuser_name}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/subusers/{subuser_name}'
@@ -143,6 +151,7 @@ sg.API(request, function (response) {
// Update IPs assigned to a subuser
// PUT /subusers/{subuser_name}/ips
+
var request = sg.emptyRequest()
request.body = [
"127.0.0.1"
@@ -159,6 +168,7 @@ sg.API(request, function (response) {
// Update Monitor Settings for a subuser
// PUT /subusers/{subuser_name}/monitor
+
var request = sg.emptyRequest()
request.body = {
"email": "example@example.com",
@@ -176,6 +186,7 @@ sg.API(request, function (response) {
// Create monitor settings
// POST /subusers/{subuser_name}/monitor
+
var request = sg.emptyRequest()
request.body = {
"email": "example@example.com",
@@ -193,6 +204,7 @@ sg.API(request, function (response) {
// Retrieve monitor settings for a subuser
// GET /subusers/{subuser_name}/monitor
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/subusers/{subuser_name}/monitor'
@@ -206,6 +218,7 @@ sg.API(request, function (response) {
// Delete monitor settings
// DELETE /subusers/{subuser_name}/monitor
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/subusers/{subuser_name}/monitor'
@@ -219,12 +232,13 @@ sg.API(request, function (response) {
// Retrieve the monthly email statistics for a single subuser
// GET /subusers/{subuser_name}/stats/monthly
+
var request = sg.emptyRequest()
request.queryParams["date"] = 'test_string'
- request.queryParams["sort_by_direction"] = 'asc'
- request.queryParams["limit"] = '0'
- request.queryParams["sort_by_metric"] = 'test_string'
- request.queryParams["offset"] = '1'
+request.queryParams["sort_by_direction"] = 'asc'
+request.queryParams["limit"] = '0'
+request.queryParams["sort_by_metric"] = 'test_string'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/subusers/{subuser_name}/stats/monthly'
sg.API(request, function (response) {
diff --git a/examples/suppression/suppression.js b/examples/suppression/suppression.js
index 2f3d637..be135ec 100644
--- a/examples/suppression/suppression.js
+++ b/examples/suppression/suppression.js
@@ -4,11 +4,12 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve all blocks
// GET /suppression/blocks
+
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
- request.queryParams["limit"] = '1'
- request.queryParams["end_time"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["end_time"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/blocks'
sg.API(request, function (response) {
@@ -21,6 +22,7 @@ sg.API(request, function (response) {
// Delete blocks
// DELETE /suppression/blocks
+
var request = sg.emptyRequest()
request.body = {
"delete_all": false,
@@ -41,6 +43,7 @@ sg.API(request, function (response) {
// Retrieve a specific block
// GET /suppression/blocks/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/suppression/blocks/{email}'
@@ -54,6 +57,7 @@ sg.API(request, function (response) {
// Delete a specific block
// DELETE /suppression/blocks/{email}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/suppression/blocks/{email}'
@@ -67,9 +71,10 @@ sg.API(request, function (response) {
// Retrieve all bounces
// GET /suppression/bounces
+
var request = sg.emptyRequest()
request.queryParams["start_time"] = '0'
- request.queryParams["end_time"] = '0'
+request.queryParams["end_time"] = '0'
request.method = 'GET'
request.path = '/v3/suppression/bounces'
sg.API(request, function (response) {
@@ -82,6 +87,7 @@ sg.API(request, function (response) {
// Delete bounces
// DELETE /suppression/bounces
+
var request = sg.emptyRequest()
request.body = {
"delete_all": true,
@@ -102,6 +108,7 @@ sg.API(request, function (response) {
// Retrieve a Bounce
// GET /suppression/bounces/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/suppression/bounces/{email}'
@@ -115,6 +122,7 @@ sg.API(request, function (response) {
// Delete a bounce
// DELETE /suppression/bounces/{email}
+
var request = sg.emptyRequest()
request.queryParams["email_address"] = 'example@example.com'
request.method = 'DELETE'
@@ -129,11 +137,12 @@ sg.API(request, function (response) {
// Retrieve all invalid emails
// GET /suppression/invalid_emails
+
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
- request.queryParams["limit"] = '1'
- request.queryParams["end_time"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["end_time"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/invalid_emails'
sg.API(request, function (response) {
@@ -146,6 +155,7 @@ sg.API(request, function (response) {
// Delete invalid emails
// DELETE /suppression/invalid_emails
+
var request = sg.emptyRequest()
request.body = {
"delete_all": false,
@@ -166,6 +176,7 @@ sg.API(request, function (response) {
// Retrieve a specific invalid email
// GET /suppression/invalid_emails/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/suppression/invalid_emails/{email}'
@@ -179,6 +190,7 @@ sg.API(request, function (response) {
// Delete a specific invalid email
// DELETE /suppression/invalid_emails/{email}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/suppression/invalid_emails/{email}'
@@ -192,6 +204,7 @@ sg.API(request, function (response) {
// Retrieve a specific spam report
// GET /suppression/spam_report/{email}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/suppression/spam_report/{email}'
@@ -205,6 +218,7 @@ sg.API(request, function (response) {
// Delete a specific spam report
// DELETE /suppression/spam_report/{email}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/suppression/spam_report/{email}'
@@ -218,11 +232,12 @@ sg.API(request, function (response) {
// Retrieve all spam reports
// GET /suppression/spam_reports
+
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
- request.queryParams["limit"] = '1'
- request.queryParams["end_time"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["end_time"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/spam_reports'
sg.API(request, function (response) {
@@ -235,6 +250,7 @@ sg.API(request, function (response) {
// Delete spam reports
// DELETE /suppression/spam_reports
+
var request = sg.emptyRequest()
request.body = {
"delete_all": false,
@@ -255,11 +271,12 @@ sg.API(request, function (response) {
// Retrieve all global suppressions
// GET /suppression/unsubscribes
+
var request = sg.emptyRequest()
request.queryParams["start_time"] = '1'
- request.queryParams["limit"] = '1'
- request.queryParams["end_time"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["end_time"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/suppression/unsubscribes'
sg.API(request, function (response) {
diff --git a/examples/templates/templates.js b/examples/templates/templates.js
index eb55075..36e5af6 100644
--- a/examples/templates/templates.js
+++ b/examples/templates/templates.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a transactional template.
// POST /templates
+
var request = sg.emptyRequest()
request.body = {
"name": "example_name"
@@ -20,6 +21,7 @@ sg.API(request, function (response) {
// Retrieve all transactional templates.
// GET /templates
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/templates'
@@ -33,6 +35,7 @@ sg.API(request, function (response) {
// Edit a transactional template.
// PATCH /templates/{template_id}
+
var request = sg.emptyRequest()
request.body = {
"name": "new_example_name"
@@ -49,6 +52,7 @@ sg.API(request, function (response) {
// Retrieve a single transactional template.
// GET /templates/{template_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/templates/{template_id}'
@@ -62,6 +66,7 @@ sg.API(request, function (response) {
// Delete a template.
// DELETE /templates/{template_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/templates/{template_id}'
@@ -75,6 +80,7 @@ sg.API(request, function (response) {
// Create a new transactional template version.
// POST /templates/{template_id}/versions
+
var request = sg.emptyRequest()
request.body = {
"active": 1,
@@ -96,6 +102,7 @@ sg.API(request, function (response) {
// Edit a transactional template version.
// PATCH /templates/{template_id}/versions/{version_id}
+
var request = sg.emptyRequest()
request.body = {
"active": 1,
@@ -116,6 +123,7 @@ sg.API(request, function (response) {
// Retrieve a specific transactional template version.
// GET /templates/{template_id}/versions/{version_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/templates/{template_id}/versions/{version_id}'
@@ -129,6 +137,7 @@ sg.API(request, function (response) {
// Delete a transactional template version.
// DELETE /templates/{template_id}/versions/{version_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/templates/{template_id}/versions/{version_id}'
@@ -142,6 +151,7 @@ sg.API(request, function (response) {
// Activate a transactional template version.
// POST /templates/{template_id}/versions/{version_id}/activate
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/templates/{template_id}/versions/{version_id}/activate'
diff --git a/examples/trackingsettings/trackingsettings.js b/examples/trackingsettings/trackingsettings.js
index 67cf029..9e67b37 100644
--- a/examples/trackingsettings/trackingsettings.js
+++ b/examples/trackingsettings/trackingsettings.js
@@ -4,9 +4,10 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Retrieve Tracking Settings
// GET /tracking_settings
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/tracking_settings'
sg.API(request, function (response) {
@@ -19,6 +20,7 @@ sg.API(request, function (response) {
// Update Click Tracking Settings
// PATCH /tracking_settings/click
+
var request = sg.emptyRequest()
request.body = {
"enabled": true
@@ -35,6 +37,7 @@ sg.API(request, function (response) {
// Retrieve Click Track Settings
// GET /tracking_settings/click
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/tracking_settings/click'
@@ -48,6 +51,7 @@ sg.API(request, function (response) {
// Update Google Analytics Settings
// PATCH /tracking_settings/google_analytics
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -69,6 +73,7 @@ sg.API(request, function (response) {
// Retrieve Google Analytics Settings
// GET /tracking_settings/google_analytics
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/tracking_settings/google_analytics'
@@ -82,6 +87,7 @@ sg.API(request, function (response) {
// Update Open Tracking Settings
// PATCH /tracking_settings/open
+
var request = sg.emptyRequest()
request.body = {
"enabled": true
@@ -98,6 +104,7 @@ sg.API(request, function (response) {
// Get Open Tracking Settings
// GET /tracking_settings/open
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/tracking_settings/open'
@@ -111,6 +118,7 @@ sg.API(request, function (response) {
// Update Subscription Tracking Settings
// PATCH /tracking_settings/subscription
+
var request = sg.emptyRequest()
request.body = {
"enabled": true,
@@ -132,6 +140,7 @@ sg.API(request, function (response) {
// Retrieve Subscription Tracking Settings
// GET /tracking_settings/subscription
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/tracking_settings/subscription'
diff --git a/examples/user/user.js b/examples/user/user.js
index fbd5acd..b2b49c2 100644
--- a/examples/user/user.js
+++ b/examples/user/user.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Get a user's account information.
// GET /user/account
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/account'
@@ -17,6 +18,7 @@ sg.API(request, function (response) {
// Retrieve your credit balance
// GET /user/credits
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/credits'
@@ -30,6 +32,7 @@ sg.API(request, function (response) {
// Update your account email address
// PUT /user/email
+
var request = sg.emptyRequest()
request.body = {
"email": "example@example.com"
@@ -46,6 +49,7 @@ sg.API(request, function (response) {
// Retrieve your account email address
// GET /user/email
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/email'
@@ -59,6 +63,7 @@ sg.API(request, function (response) {
// Update your password
// PUT /user/password
+
var request = sg.emptyRequest()
request.body = {
"new_password": "new_password",
@@ -76,6 +81,7 @@ sg.API(request, function (response) {
// Update a user's profile
// PATCH /user/profile
+
var request = sg.emptyRequest()
request.body = {
"city": "Orange",
@@ -94,6 +100,7 @@ sg.API(request, function (response) {
// Get a user's profile
// GET /user/profile
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/profile'
@@ -107,6 +114,7 @@ sg.API(request, function (response) {
// Cancel or pause a scheduled send
// POST /user/scheduled_sends
+
var request = sg.emptyRequest()
request.body = {
"batch_id": "YOUR_BATCH_ID",
@@ -124,6 +132,7 @@ sg.API(request, function (response) {
// Retrieve all scheduled sends
// GET /user/scheduled_sends
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/scheduled_sends'
@@ -137,6 +146,7 @@ sg.API(request, function (response) {
// Update user scheduled send information
// PATCH /user/scheduled_sends/{batch_id}
+
var request = sg.emptyRequest()
request.body = {
"status": "pause"
@@ -153,6 +163,7 @@ sg.API(request, function (response) {
// Retrieve scheduled send
// GET /user/scheduled_sends/{batch_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/scheduled_sends/{batch_id}'
@@ -166,6 +177,7 @@ sg.API(request, function (response) {
// Delete a cancellation or pause of a scheduled send
// DELETE /user/scheduled_sends/{batch_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/user/scheduled_sends/{batch_id}'
@@ -179,6 +191,7 @@ sg.API(request, function (response) {
// Update Enforced TLS settings
// PATCH /user/settings/enforced_tls
+
var request = sg.emptyRequest()
request.body = {
"require_tls": true,
@@ -196,6 +209,7 @@ sg.API(request, function (response) {
// Retrieve current Enforced TLS settings.
// GET /user/settings/enforced_tls
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/settings/enforced_tls'
@@ -209,6 +223,7 @@ sg.API(request, function (response) {
// Update your username
// PUT /user/username
+
var request = sg.emptyRequest()
request.body = {
"username": "test_username"
@@ -225,6 +240,7 @@ sg.API(request, function (response) {
// Retrieve your username
// GET /user/username
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/username'
@@ -238,6 +254,7 @@ sg.API(request, function (response) {
// Update Event Notification Settings
// PATCH /user/webhooks/event/settings
+
var request = sg.emptyRequest()
request.body = {
"bounce": true,
@@ -266,6 +283,7 @@ sg.API(request, function (response) {
// Retrieve Event Webhook settings
// GET /user/webhooks/event/settings
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/webhooks/event/settings'
@@ -279,6 +297,7 @@ sg.API(request, function (response) {
// Test Event Notification Settings
// POST /user/webhooks/event/test
+
var request = sg.emptyRequest()
request.body = {
"url": "url"
@@ -295,6 +314,7 @@ sg.API(request, function (response) {
// Retrieve Parse Webhook settings
// GET /user/webhooks/parse/settings
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/user/webhooks/parse/settings'
@@ -308,12 +328,13 @@ sg.API(request, function (response) {
// Retrieves Inbound Parse Webhook statistics.
// GET /user/webhooks/parse/stats
+
var request = sg.emptyRequest()
request.queryParams["aggregated_by"] = 'day'
- request.queryParams["limit"] = 'test_string'
- request.queryParams["start_date"] = '2016-01-01'
- request.queryParams["end_date"] = '2016-04-01'
- request.queryParams["offset"] = 'test_string'
+request.queryParams["limit"] = 'test_string'
+request.queryParams["start_date"] = '2016-01-01'
+request.queryParams["end_date"] = '2016-04-01'
+request.queryParams["offset"] = 'test_string'
request.method = 'GET'
request.path = '/v3/user/webhooks/parse/stats'
sg.API(request, function (response) {
diff --git a/examples/whitelabel/whitelabel.js b/examples/whitelabel/whitelabel.js
index 2416785..a9532b1 100644
--- a/examples/whitelabel/whitelabel.js
+++ b/examples/whitelabel/whitelabel.js
@@ -4,6 +4,7 @@ var sg = require('../lib/sendgrid.js').SendGrid(process.env.SENDGRID_API_KEY)
// Create a domain whitelabel.
// POST /whitelabel/domains
+
var request = sg.emptyRequest()
request.body = {
"automatic_security": false,
@@ -29,12 +30,13 @@ sg.API(request, function (response) {
// List all domain whitelabels.
// GET /whitelabel/domains
+
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
- request.queryParams["domain"] = 'test_string'
- request.queryParams["exclude_subusers"] = 'true'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["domain"] = 'test_string'
+request.queryParams["exclude_subusers"] = 'true'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/whitelabel/domains'
sg.API(request, function (response) {
@@ -47,6 +49,7 @@ sg.API(request, function (response) {
// Get the default domain whitelabel.
// GET /whitelabel/domains/default
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/whitelabel/domains/default'
@@ -60,6 +63,7 @@ sg.API(request, function (response) {
// List the domain whitelabel associated with the given user.
// GET /whitelabel/domains/subuser
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/whitelabel/domains/subuser'
@@ -73,6 +77,7 @@ sg.API(request, function (response) {
// Disassociate a domain whitelabel from a given user.
// DELETE /whitelabel/domains/subuser
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/subuser'
@@ -86,6 +91,7 @@ sg.API(request, function (response) {
// Update a domain whitelabel.
// PATCH /whitelabel/domains/{domain_id}
+
var request = sg.emptyRequest()
request.body = {
"custom_spf": true,
@@ -103,6 +109,7 @@ sg.API(request, function (response) {
// Retrieve a domain whitelabel.
// GET /whitelabel/domains/{domain_id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/whitelabel/domains/{domain_id}'
@@ -116,6 +123,7 @@ sg.API(request, function (response) {
// Delete a domain whitelabel.
// DELETE /whitelabel/domains/{domain_id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/{domain_id}'
@@ -129,6 +137,7 @@ sg.API(request, function (response) {
// Associate a domain whitelabel with a given user.
// POST /whitelabel/domains/{domain_id}/subuser
+
var request = sg.emptyRequest()
request.body = {
"username": "jane@example.com"
@@ -145,6 +154,7 @@ sg.API(request, function (response) {
// Add an IP to a domain whitelabel.
// POST /whitelabel/domains/{id}/ips
+
var request = sg.emptyRequest()
request.body = {
"ip": "192.168.0.1"
@@ -161,6 +171,7 @@ sg.API(request, function (response) {
// Remove an IP from a domain whitelabel.
// DELETE /whitelabel/domains/{id}/ips/{ip}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/whitelabel/domains/{id}/ips/{ip}'
@@ -174,6 +185,7 @@ sg.API(request, function (response) {
// Validate a domain whitelabel.
// POST /whitelabel/domains/{id}/validate
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/whitelabel/domains/{id}/validate'
@@ -187,6 +199,7 @@ sg.API(request, function (response) {
// Create an IP whitelabel
// POST /whitelabel/ips
+
var request = sg.emptyRequest()
request.body = {
"domain": "example.com",
@@ -205,10 +218,11 @@ sg.API(request, function (response) {
// Retrieve all IP whitelabels
// GET /whitelabel/ips
+
var request = sg.emptyRequest()
request.queryParams["ip"] = 'test_string'
- request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["limit"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'GET'
request.path = '/v3/whitelabel/ips'
sg.API(request, function (response) {
@@ -221,6 +235,7 @@ sg.API(request, function (response) {
// Retrieve an IP whitelabel
// GET /whitelabel/ips/{id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/whitelabel/ips/{id}'
@@ -234,6 +249,7 @@ sg.API(request, function (response) {
// Delete an IP whitelabel
// DELETE /whitelabel/ips/{id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/whitelabel/ips/{id}'
@@ -247,6 +263,7 @@ sg.API(request, function (response) {
// Validate an IP whitelabel
// POST /whitelabel/ips/{id}/validate
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/whitelabel/ips/{id}/validate'
@@ -260,6 +277,7 @@ sg.API(request, function (response) {
// Create a Link Whitelabel
// POST /whitelabel/links
+
var request = sg.emptyRequest()
request.body = {
"default": true,
@@ -267,7 +285,7 @@ request.body = {
"subdomain": "mail"
};
request.queryParams["limit"] = '1'
- request.queryParams["offset"] = '1'
+request.queryParams["offset"] = '1'
request.method = 'POST'
request.path = '/v3/whitelabel/links'
sg.API(request, function (response) {
@@ -280,6 +298,7 @@ sg.API(request, function (response) {
// Retrieve all link whitelabels
// GET /whitelabel/links
+
var request = sg.emptyRequest()
request.queryParams["limit"] = '1'
request.method = 'GET'
@@ -294,6 +313,7 @@ sg.API(request, function (response) {
// Retrieve a Default Link Whitelabel
// GET /whitelabel/links/default
+
var request = sg.emptyRequest()
request.queryParams["domain"] = 'test_string'
request.method = 'GET'
@@ -308,6 +328,7 @@ sg.API(request, function (response) {
// Retrieve Associated Link Whitelabel
// GET /whitelabel/links/subuser
+
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
request.method = 'GET'
@@ -322,6 +343,7 @@ sg.API(request, function (response) {
// Disassociate a Link Whitelabel
// DELETE /whitelabel/links/subuser
+
var request = sg.emptyRequest()
request.queryParams["username"] = 'test_string'
request.method = 'DELETE'
@@ -336,6 +358,7 @@ sg.API(request, function (response) {
// Update a Link Whitelabel
// PATCH /whitelabel/links/{id}
+
var request = sg.emptyRequest()
request.body = {
"default": true
@@ -352,6 +375,7 @@ sg.API(request, function (response) {
// Retrieve a Link Whitelabel
// GET /whitelabel/links/{id}
+
var request = sg.emptyRequest()
request.method = 'GET'
request.path = '/v3/whitelabel/links/{id}'
@@ -365,6 +389,7 @@ sg.API(request, function (response) {
// Delete a Link Whitelabel
// DELETE /whitelabel/links/{id}
+
var request = sg.emptyRequest()
request.method = 'DELETE'
request.path = '/v3/whitelabel/links/{id}'
@@ -378,6 +403,7 @@ sg.API(request, function (response) {
// Validate a Link Whitelabel
// POST /whitelabel/links/{id}/validate
+
var request = sg.emptyRequest()
request.method = 'POST'
request.path = '/v3/whitelabel/links/{id}/validate'
@@ -391,6 +417,7 @@ sg.API(request, function (response) {
// Associate a Link Whitelabel
// POST /whitelabel/links/{link_id}/subuser
+
var request = sg.emptyRequest()
request.body = {
"username": "jane@example.com"