This repository has been archived by the owner on Aug 27, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 967
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1818 from sendgrid/develop
5/18/2016 Docs Updates
- Loading branch information
Showing
52 changed files
with
560 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,71 +4,184 @@ weight: 100 | |
| title: Users API | ||
| seo: | ||
| description: View and Manage your user profile via the SendGrid v3 API | ||
| title: User API | ||
| title: Users API | ||
| navigation: | ||
| show: true | ||
| --- | ||
| FORMAT: 1A | ||
|
|
||
| # Users | ||
|
|
||
| ## User Profile [/user/profile] | ||
|
|
||
| ### GET User Profile [GET] | ||
| Retrieve your current user profile details. | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "address":"814 West Chapman Avenue", | ||
| "city":"Orange", | ||
| "company":"SendGrid", | ||
| "country":"US", | ||
| "first_name":"Test", | ||
| "last_name":"User", | ||
| "phone":"555-555-5555", | ||
| "state":"CA", | ||
| "website":"http://www.sendgrid.com", | ||
| "zip":"92868" | ||
| } | ||
| { | ||
| "address":"814 West Chapman Avenue", | ||
| "city":"Orange", | ||
| "company":"SendGrid", | ||
| "country":"US", | ||
| "first_name":"Test", | ||
| "last_name":"User", | ||
| "phone":"555-555-5555", | ||
| "state":"CA", | ||
| "website":"http://www.sendgrid.com", | ||
| "zip":"92868" | ||
| } | ||
|
|
||
| ### PATCH User Profile [PATCH] | ||
| Update your user profile. | ||
|
|
||
| + Request (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "city": "Orange" | ||
| } | ||
| { | ||
| "city": "Orange" | ||
| } | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "address":"814 West Chapman Avenue", | ||
| "city":"Orange", | ||
| "company":"SendGrid", | ||
| "country":"US", | ||
| "first_name":"Test", | ||
| "last_name":"User", | ||
| "phone":"555-555-5555", | ||
| "state":"CA", | ||
| "website":"http://www.sendgrid.com", | ||
| "zip":"92868" | ||
| } | ||
| { | ||
| "address":"814 West Chapman Avenue", | ||
| "city":"Orange", | ||
| "company":"SendGrid", | ||
| "country":"US", | ||
| "first_name":"Test", | ||
| "last_name":"User", | ||
| "phone":"555-555-5555", | ||
| "state":"CA", | ||
| "website":"http://www.sendgrid.com", | ||
| "zip":"92868" | ||
| } | ||
|
|
||
| ## User Account [/user/account] | ||
|
|
||
| ### GET User Account [GET] | ||
| Retrieve your user account details. | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "type": "free", | ||
| "reputation": 99.7 | ||
| } | ||
|
|
||
|
|
||
| ## User Email [/user/email] | ||
|
|
||
| ### GET User Email [GET] | ||
| Retrieve the email address on file for your account. | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "email": "[email protected]" | ||
| } | ||
|
|
||
|
|
||
| ### PUT User Email [PUT] | ||
| Update the email address on file for your account. | ||
|
|
||
| + Request (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "email": "[email protected]" | ||
| } | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "email": "[email protected]" | ||
| } | ||
|
|
||
| ## User Username [/user/username] | ||
|
|
||
| ### GET User Username [GET] | ||
| Retrieve your account username. | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "username": "test_username", | ||
| "user_id": 1 | ||
| } | ||
|
|
||
|
|
||
| ### PUT User Username [PUT] | ||
| Update your account username. | ||
|
|
||
| + Request (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "username": "test_username" | ||
| } | ||
|
|
||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "username": "test_username" | ||
| } | ||
|
|
||
|
|
||
| ## User Credits [/user/credits] | ||
|
|
||
| ### GET User Credits [GET] | ||
| Retrieve the current credit balance for your account. | ||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "remain": 200, | ||
| "total": 200, | ||
| "overage": 0, | ||
| "used": 0, | ||
| "last_reset": "2013-01-01", | ||
| "next_reset": "2013-02-01", | ||
| "reset_frequency": "monthly" | ||
| } | ||
|
|
||
| ## User Password [/user/password] | ||
|
|
||
| ### PUT User Password [PUT] | ||
| Update the password for your account. | ||
|
|
||
| + Request (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "new_password": "new_password", | ||
| "old_password": "old_password" | ||
| } | ||
|
|
||
|
|
||
| + Response 200 (application/json) | ||
|
|
||
| + Body | ||
|
|
||
| { | ||
| "type": "free", | ||
| "reputation": 99.7 | ||
|
|
||
| } | ||
18 changes: 18 additions & 0 deletions
18
...Basics/Account/why_cant_I_reset_my_password_if_my_account_is_not_provisioned.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| st: | ||
| published_at: 2016-05-17 | ||
| type: Utilities | ||
| seo: | ||
| title: Why can’t I reset my password if my account is not provisioned? | ||
| description: Why can’t I reset my password if my account is not provisioned? | ||
| keywords: log, don't, username, user, in, name, api_user, ID, forgot, know, my | ||
| title: Why can’t I reset my password if my account is not provisioned? | ||
| weight: 0 | ||
| layout: page | ||
| navigation: | ||
| show: true | ||
| --- | ||
|
|
||
| You will not be able to reset the password for an account where your email address has [not yet been confirmed]({{root_url}}/Classroom/Troubleshooting/Account_Administration/cant_log_in_to_your_account.html). However, you will also not be able confirm your email address and activate the account without knowing your account’s username and the password. So how do you move forward? | ||
|
|
||
| As it turns out, the only option would be to [create another account](https://sendgrid.com/pricing). Once the new account is created, please [reach out to support](http://support.sendgrid.com) and let us know what the new username is and what happened, so we can expedite the provisioning process for you. We can then make sure you are not turned down due to signing up for multiple accounts with the same information. Remember, you are only charged for paid accounts after you are sucessfully provisioned, so there is no need to worry when creating a new paid account to get around this scenario. |
38 changes: 38 additions & 0 deletions
38
.../Sender_Authentication/what_is_automated_security_in_the_whitelabel_settings.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| st: | ||
| published_at: 2016-05-16 | ||
| type: Classroom | ||
| seo: | ||
| title: What is Automated Security in the Whitelabel settings? | ||
| description: What is Automated Security in the Whitelabel settings? | ||
| keywords: automated, security, spf, whitelabel, domain, dkim | ||
| title: What is Automated Security in the Whitelabel settings? | ||
| weight: 0 | ||
| layout: page | ||
| zendesk_id: 202517236 | ||
| navigation: | ||
| show: true | ||
| --- | ||
|
|
||
| #Automated Security | ||
|
|
||
|  | ||
|
|
||
| By enabling Automatic Security on your [domain whitelabels]({{root_url}}/User_Guide/Settings/Whitelabel/domains.html), SendGrid can manage your [DKIM]({{root_url}}/Glossary/dkim.html) and [SPF]({{root_url}}/Glossary/spf.html) records for you. | ||
|
|
||
| Setting up three custom [CNAME records]({{root_url}}/Glossary/cname.html) displayed during whitelabel setup will allow SendGrid to rotate between custom DKIM keys periodically without requiring you to make additional updates to [DNS]({{root_url}}/Glossary/dns.html). We will also generate a custom SPF that includes only the IPs that you'll be sending from (as opposed to ~all sendgrid.net). | ||
|
|
||
| To clarify, you will still need to create some DNS records initially to allow us to take over this process. The DNS records you'll need to create will depend on whether you chose automated or manual security, the IP addresses on your account, and the domain you are whitelabeling. | ||
|
|
||
|
|
||
|
|
||
| #Manual Security | ||
|
|
||
|  | ||
|
|
||
| If you choose not to have SendGrid manage your DNS records for DKIM, then you’ll be shown all of the manual DNS records that you need to enter at your registrar or host. You will be responsible for making any updates to your DNS for any changes on your account when selecting this options. | ||
|
|
||
| The records you are given will be MX, DKIM, and SPF records to enter at your registrar, hosting company, or DNS manager. This will also mean that your SPF record will include all of SendGrid’s IP addresses. | ||
|
|
||
| For more information about whitelabeling, please read [All You Need to Know About Whitelabeling]({{root_url}}/Classroom/Deliver/Delivery_Introduction/all_you_need_to_know_about_whitelabeling.html), or visit our [User Guide]({{root_url}}/User_Guide/Settings/Whitelabel/index.html). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 0 additions & 17 deletions
17
source/Classroom/Track/Introduction/what_do_all_these_delivery_statistics_mean.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.