You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: USAGE.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ puts response.headers
136
136
```
137
137
## Retrieve a specific whitelisted IP
138
138
139
-
**This endpoint allows you to retreive a specific IP address that has been whitelisted.**
139
+
**This endpoint allows you to retrieve a specific IP address that has been whitelisted.**
140
140
141
141
You must include the ID for the specific IP address you want to retrieve in your call.
142
142
@@ -203,7 +203,7 @@ puts response.headers
203
203
```
204
204
## Retrieve all alerts
205
205
206
-
**This endpoint allows you to retieve all of your alerts.**
206
+
**This endpoint allows you to retrieve all of your alerts.**
207
207
208
208
Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.
209
209
* Usage alerts allow you to set the threshold at which an alert will be sent.
@@ -288,7 +288,7 @@ puts response.headers
288
288
289
289
## Create API keys
290
290
291
-
**This enpoint allows you to create a new random API Key for the user.**
291
+
**This endpoint allows you to create a new random API Key for the user.**
292
292
293
293
A JSON request body containing a "name" property is required. If number of maximum keys is reached, HTTP 403 will be returned.
294
294
@@ -2705,7 +2705,7 @@ puts response.headers
2705
2705
2706
2706
**This endpoint returns a list of all scopes that this user has access to.**
2707
2707
2708
-
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).
2708
+
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 permissions, 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).
2709
2709
2710
2710
### GET /scopes
2711
2711
@@ -2821,7 +2821,7 @@ puts response.headers
2821
2821
```
2822
2822
## Delete a Sender Identity
2823
2823
2824
-
**This endoint allows you to delete one of your sender identities.**
2824
+
**This endpoint allows you to delete one of your sender identities.**
2825
2825
2826
2826
Sender Identities are required to be verified before use. If your domain has been whitelabeled it will auto verify on creation. Otherwise an email will be sent to the `from.email`.
2827
2827
@@ -3124,7 +3124,7 @@ puts response.headers
3124
3124
```
3125
3125
## Retrieve the monthly email statistics for a single subuser
3126
3126
3127
-
**This endpoint allows you to retrive the monthly email statistics for a specific subuser.**
3127
+
**This endpoint allows you to retrieve the monthly email statistics for a specific subuser.**
3128
3128
3129
3129
While you can always view the statistics for all email activity on your account, subuser statistics enable you to view specific segments of your stats for your subusers. Emails sent, bounces, and spam reports are always tracked for subusers. Unsubscribes, clicks, and opens are tracked if you have enabled the required settings.
3130
3130
@@ -3620,7 +3620,7 @@ puts response.headers
3620
3620
3621
3621
**This endpoint allows you to create a new version of a template.**
3622
3622
3623
-
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
3623
+
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.
3624
3624
3625
3625
For more information about transactional templates, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
3626
3626
@@ -3647,7 +3647,7 @@ puts response.headers
3647
3647
3648
3648
**This endpoint allows you to edit a version of one of your transactional templates.**
3649
3649
3650
-
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
3650
+
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.
3651
3651
3652
3652
For more information about transactional templates, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
3653
3653
@@ -3679,7 +3679,7 @@ puts response.headers
3679
3679
3680
3680
**This endpoint allows you to retrieve a specific version of a template.**
3681
3681
3682
-
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
3682
+
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.
3683
3683
3684
3684
For more information about transactional templates, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
3685
3685
@@ -3704,7 +3704,7 @@ puts response.headers
3704
3704
3705
3705
**This endpoint allows you to delete one of your transactional template versions.**
3706
3706
3707
-
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
3707
+
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.
3708
3708
3709
3709
For more information about transactional templates, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
3710
3710
@@ -3729,7 +3729,7 @@ puts response.headers
3729
3729
3730
3730
**This endpoint allows you to activate a version of one of your templates.**
3731
3731
3732
-
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across across all templates.
3732
+
Each transactional template can have multiple versions, each version with its own subject and content. Each user can have up to 300 versions across all templates.
3733
3733
3734
3734
3735
3735
For more information about transactional templates, please see our [User Guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html).
@@ -3974,7 +3974,7 @@ puts response.headers
3974
3974
3975
3975
**This endpoint allows you to retrieve the current credit balance for your account.**
3976
3976
3977
-
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Clssroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
3977
+
Your monthly credit allotment limits the number of emails you may send before incurring overage charges. For more information about credits and billing, please visit our [Classroom](https://sendgrid.com/docs/Classroom/Basics/Billing/billing_info_and_faqs.html).
3978
3978
3979
3979
### GET /user/credits
3980
3980
@@ -4357,7 +4357,7 @@ puts response.headers
4357
4357
4358
4358
**This endpoint allows you to retrieve all of your current inbound parse settings.**
4359
4359
4360
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4360
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4361
4361
4362
4362
### GET /user/webhooks/parse/settings
4363
4363
@@ -4372,7 +4372,7 @@ puts response.headers
4372
4372
4373
4373
**This endpoint allows you to update a specific inbound parse setting.**
4374
4374
4375
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4375
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
**This endpoint allows you to retrieve a specific inbound parse setting.**
4395
4395
4396
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4396
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4397
4397
4398
4398
### GET /user/webhooks/parse/settings/{hostname}
4399
4399
@@ -4409,7 +4409,7 @@ puts response.headers
4409
4409
4410
4410
**This endpoint allows you to delete a specific inbound parse setting.**
4411
4411
4412
-
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
4412
+
The inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the content, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
**This endpoint allows you to retrieve the statistics for your Parse Webhook useage.**
4426
+
**This endpoint allows you to retrieve the statistics for your Parse Webhook usage.**
4427
4427
4428
-
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
4428
+
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incoming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 20MB in size, including all attachments.
4429
4429
4430
4430
There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the [Library Index](https://sendgrid.com/docs/Integrate/libraries.html#-Webhook-Libraries).
4431
4431
@@ -4751,7 +4751,7 @@ puts response.headers
4751
4751
```
4752
4752
## Retrieve all IP whitelabels
4753
4753
4754
-
**This endpoint allows you to retrieve all of the IP whitelabels that have been createdy by this account.**
4754
+
**This endpoint allows you to retrieve all of the IP whitelabels that have been created by this account.**
4755
4755
4756
4756
You may include a search key by using the "ip" parameter. This enables you to perform a prefix search for a given IP segment (e.g. "192.").
4757
4757
@@ -4894,7 +4894,7 @@ puts response.headers
4894
4894
**This endpoint allows you to retrieve the associated link whitelabel for a subuser.**
4895
4895
4896
4896
Link whitelables can be associated with subusers from the parent account. This functionality allows
4897
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4897
+
subusers to send mail using their parent's like whitelabels. To associate a link whitelabel, the parent account
4898
4898
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
4899
4899
4900
4900
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -4916,7 +4916,7 @@ puts response.headers
4916
4916
**This endpoint allows you to disassociate a link whitelabel from a subuser.**
4917
4917
4918
4918
Link whitelables can be associated with subusers from the parent account. This functionality allows
4919
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
4919
+
subusers to send mail using their parent's like whitelabels. To associate a link whitelabel, the parent account
4920
4920
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
4921
4921
4922
4922
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
@@ -5013,7 +5013,7 @@ puts response.headers
5013
5013
**This endpoint allows you to associate a link whitelabel with a subuser account.**
5014
5014
5015
5015
Link whitelables can be associated with subusers from the parent account. This functionality allows
5016
-
subusers to send mail using their parent's linke whitelabels. To associate a link whitelabel, the parent account
5016
+
subusers to send mail using their parent's like whitelabels. To associate a link whitelabel, the parent account
5017
5017
must first create a whitelabel and validate it. The parent may then associate that whitelabel with a subuser via the API or the Subuser Management page in the user interface.
5018
5018
5019
5019
Email link whitelabels allow all of the click-tracked links you send in your emails to include the URL of your domain instead of sendgrid.net.
0 commit comments