Skip to content
This repository has been archived by the owner on Aug 27, 2021. It is now read-only.

Releases: sendgrid/docs

5/24/2016 Docs Updates

26 May 21:51
@eschallock eschallock
20160524
f76a60c
Compare
Choose a tag to compare
5/24/2016 Docs Updates

Added

User Guide

  • Added ability to delete all contacts in Marketing Campaigns
    • /User_Guide/Marketing_Campaigns/contacts.html

Classroom

  • Added new contact information for Support

Changed

All Over

  • Design Updates
    • Created a "large" button class and adjusted spacing on our footer
      • /_assets/stylesheets/components/buttons.less
  • Updates to Google Analytics
    • /_includes/google_analytics.html

API

  • Updated Marketing Campaigns Contacts API 404 handling docs
    • /API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html

Classroom

  • Edited for clarity
    • /Classroom/Basics/Billing/alternate_payment_methods.html
    • /Classroom/Basics/Billing/billing_info_and_faqs.html

PRs

Assets 2
Loading

5/19/2016 Docs Update

19 May 23:03
@eschallock eschallock
20160519
3210c2d
Compare
Choose a tag to compare
5/19/2016 Docs Update

Added

API

  • Added documentation for the new Marketing Campaigns Sender Identities API
    • /API_Reference/Web_API_v3/Marketing_Campaigns/sender_identities.html

PRs

Assets 2
Loading

5/18/2016 Docs Updates

19 May 15:47
@eschallock eschallock
20160518
3e0155f
Compare
Choose a tag to compare
5/18/2016 Docs Updates

Added

Integrate

  • Created /Integrate/Code_Examples/v2_Mail
  • Created /Integrate/Code_Examples/v3_Mail
  • /Integrate/Code_Examples/v2_Mail/index.html
  • /Integrate/Code_Examples/v3_Mail/index.html

Classroom

  • /Classroom/Troubleshooting/Authentication/whitelabel_video_tutorials.html

Changed

All Over

  • Added new, temporary footer
    • /_assets/stylesheets/base/default.less
    • /_assets/stylesheets/base/typography.less
    • /_assets/stylesheets/base/variables.less
    • /_assets/stylesheets/components/footer.less
    • /_includes/footer.html

User Guide

  • /User_Guide/Settings/tracking.html

API

  • /API_Reference/Web_API_v3/API_Keys/api_key_permissions_list.html
  • /API_Reference/Web_API_v3/user.html
  • /API_Reference/Web_API_v3/Settings/mail.html
  • /API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html

Classroom

  • Classroom/Basics/Account/why_cant_I_reset_my_password_if_my_account_is_not_provisioned.html

Deleted

Classroom

  • /Classroom/Track/Introduction/what_do_all_these_delivery_statistics_mean.html

PRs

Assets 2
Loading

5/10/2016 Docs Updates

19 May 15:34
@eschallock eschallock
20160510
212d0b0
Compare
Choose a tag to compare
5/10/2016 Docs Updates

Added

API

  • /API_Reference/Web_API_v3/errors.html
  • /API_Reference/Web_API_v3/overview.html

Classroom

  • /Classroom/Send/v3_Mail_Send/curl_examples.html
  • /Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html
  • /Classroom/Send/v3_Mail_Send/personalizations.html
  • /Classroom/Send/v3_Mail_Send/sandbox_mode.html

Changed

All Over

  • We have updated all references to v2 Mail Send to instead point to v3 Mail Send, with links to our new v3 Mail Send documentation

API

  • /API_Reference/SMTP_API/suppressions.md
  • /API_Reference/Web_API/mail.md
  • /API_Reference/Web_API_v3/API_Keys/index.apiblueprint
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/authentication.md
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/errors.md
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/index.html
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/rate_limits.md
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/requests.md
  • /API_Reference/Web_API_v3/How_To_Use_The_Web_API_v3/responses.md
  • /API_Reference/Web_API_v3/Mail/errors.md
  • /API_Reference/Web_API_v3/Mail/overview.md
  • /API_Reference/Web_API_v3/Settings/mail.apiblueprint
  • /API_Reference/Web_API_v3/Transactional_Templates/index.md
  • /API_Reference/Web_API_v3/Transactional_Templates/smtpapi.md
  • /API_Reference/Web_API_v3/index.md
  • /API_Reference/index.html

Glossary

  • /Glossary/autoresponder.md

User Guide

  • /User_Guide/Settings/credentials.md

Classroom

  • /Classroom/Basics/Account/resetting_your_password_without_breaking_current_integrations.md
  • /Classroom/Basics/Security/sendgrid_multiauth_multiple_account_credentials.md
  • /Classroom/Build/Add_Content/attachments.md
  • /Classroom/Send/How_Emails_Are_Sent/api_keys.md
  • /Classroom/Troubleshooting/Delivery_Issues/troubleshooting_delays_and_latency.md

PRs

Assets 2
Loading

4/11/2016 Docs Updates

11 Apr 23:41
@eschallock eschallock
20151131
2647519
Compare
Choose a tag to compare
4/11/2016 Docs Updates

Changed

All Over

  • /_redirects.htaccess
    • Added redirects for old Classroom articles, Integrate Page

API

  • /API_Reference/Web_API_v3/IP_Management/ip_pools.html
    • Changed the formatting to fix how the page is rendered

Integrate

  • /Integrate/Tutorials/Segment
    • changed folder "segment" to "Segment"

User Guide

  • /User_Guide/Settings/ip_access_management.html
    • Added warning to Docs about using IPAM with IPs that are not static
    • Changed link to KB to point to corresponding Classroom article

PRs

Assets 2
Loading

Docs Release Notes 10/27/15 - 11/19/15

30 Nov 16:11
@eschallock eschallock
20151130
4163e4a
Compare
Choose a tag to compare
Docs Release Notes 10/27/15 - 11/19/15

Added

Assets

  • /source/assets/IPWarmupSchedule.pdf

API

  • /API_Reference/Web_API_v3/bounces.html added bounces endpoints
  • /SMTP_API/scheduling_parameters.html added Cancel Schedule Send params
  • /API_Reference/Web_API_v3/cancel_schedule_send.html - full cancel schedule send info
  • /API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html - marketing Campaigns API
  • /API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html - marketing Campaigns Contact Database API
  • /API_Reference/Web_API/Customer_Subuser_API/multi_cred.html - fixed typo

Glossary

  • /Auto Responder
  • /Automated Email
  • /Bayesian Filter
  • /CAN-SPAM
  • /Drip Campaign
  • /Opt-In Email
  • /Triggered Actions
  • /Triggered Email
  • /Triggering Events

User Guide

  • Added new video to User Guide/Dashboard
  • /User_Guide/Marketing_Campaigns/Campaigns/index.html - added video
  • /User_Guide/Marketing_Campaigns/index.html - updated the video on Marketing Campaigns index page

Integrate

  • /Integrate/Tutorials/Zapier/ - we added several tutorials for SendGrid/Zapier integration:
    • Sending New Emails via SendGrid For New Gravity Form Submissions
    • Send Emails Through SendGrid For New Caught Webhook Data
    • Sending SendGrid Emails For New PostgreSQL Custom Query Row Matches
    • Sending SendGrid Emails From New Google Sheets Rows
    • Sending Emails From SendGrid to Tagged Infusionsoft Contacts
    • Sending SendGrid Email When New Firebase Child Records Are Added

Changed

All Over

  • Changed the name of Advanced Suppression Manager to Suppression Management
  • Changed suppression groups to Unsubscribe Groups
  • Links to the unsubscribe links section, within the places people might look for them
  • There was a bug in some instances with our redirects plugin that was causing a stack overload error, we fixed that.
  • Added custom Error code Parser to the Blueprint parser, it parses Key Value fields in 4xx response blocks
  • /source/_redirects.htaccess - updated to reflect added/removed pages, various edits to broken links were made
  • Edited Gemfile and Gemfile.lock to resolve error with changes in Develop not being displayed on sendgrid.com/docs after merging to Master

API

  • /API_Reference/Web_API/Customer_Subuser_API/multi_cred.html - fixed typo
  • /API_Reference/Web_API_v3/API_Keys/index.html - includes a reference to a single API Key endpoint
  • /API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html - fixed broken links to UI Pages in error messages
  • /API_Reference/Webhooks/event.html - now includes example event data with event specific parameters for Campaign Sends, A/B Test Sends, and Winning Phase of A/B Test in Marketing Campaigns
  • API_Reference/SMTP_API/scheduling_parameters.html - schedule sends can now be cancelled if a batch ID is included in send. Links to /API_Reference/Web_API_v3/cancel_schedule_send.html
  • Updated Customer Management
  • Updated IP Addresses
  • You now have the ability to decide which Unsub groups are displayed when a customer unsubscribes
  • All /API_Reference/Marketing_Emails_API/ are marked as legacy
  • /API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.apiblueprint
    • Added/Changed
      • [DELETE] Deleting a custom field - changed 204 Response to 202
      • [PATCH] Updating a list - returns 400 if “name” is invalid
      • [DELETE] Deleting a list - changed 204 Response to 202
      • [DELETE] Deleting a list - returns 400 if “delete_contacts” is invalid
      • [POST] Adding single recipient - returns 400 if “list_id” or “recipient_id” is invalid
      • [DELETE] Deleting a recipient(s) - returns 400 if all provided “recipient_id” are invalid (previously, only if one or more “recipient_id” invalid)
      • [POST] Creating a Segment - now accepts new fields: “last_clicked” and “clicks.campaign_identifier”
      • [PATCH] Updating a segment - returns 400 if “name” or “list_id” is invalid
      • [DELETE] Deleting a segment - includes “delete_contacts” in 400 Response if “delete_contacts” not a valid boolean
      • [GET] List Recipients On a Segment - includes custom fields in 200 Response, condensed “List Recipients On a Segment” and “List Recipients On a Segment According to Page and Page Size”
      • Updated valid operators for creating/updating Group Segments
    • Removed
      • [DELETE] Delete a Single Recipient From a Single List - removed “recipient_id” in 400 Response if “recipient_id” not in list
      • [POST] Add Single Recipient - removed 400 Response when recipient ids are invalid
      • [POST] Add Multiple Recipients - removed 400 Response when none of the recipient emails are defined/valid
        */API_Reference/Webhooks/event.html - added new event webhook params
        “type”, “ip”, “tls”, “cert_error”
        */API_Reference/SMTP_API/suppressions.html - fixed spelling error
        source/index.html - Link to the Web API on Docs index page now points to Web APIv3

Integrate

  • Added example code to /Integrate/Frameworks/Laravel for integration to SendGrid categories and custom variables for SendGrid notification tracking
  • added DeliverAsync call to the C# docs
  • /Integrate/Code_Examples/csharp.html added async info for command line instructions
  • /Integrate/libraries.html updated the EventKit URLs

User Guide

  • /User_Guide/Settings/mail.html - URL from the Spam Checker App is now mandatory
  • /User_Guide/Settings/Credentials notes that multiple authentication referrs to credentials, and links to /User_Guide/Settings/Multifactor Authentication
  • New Substitution tags for Unsubscribe groups, global, and preferences within emails
  • New UI for defaulting some Unsubscribe groups
  • /User_Guide/Settings/Whitelabel/faq.html - added information about migrating old whitelabel and a link to the KB
  • All /User_Guide/Marketing_Emails/ pages are marked as Legacy
  • /User_Guide/Marketing_Campaigns/templates. html - updated application limits for image size, image library size, max number of templates, and changed autosave frequency to 2 minutes, added note about ability to duplicate templates directly from a campaign
  • /User_Guide/Marketing_Campaigns/drag_drop.html - updated to include divider module, added note about ability to duplicate modules
  • /User_Guide/Marketing_Campaigns/Campaigns/index.html - added test email limits, added ability to toggle between raw numbers and percentages in campaign stats
  • /User_Guide/Marketing_Campaigns/index.html - updated the video
  • /User_Guide/Marketing_Campaigns/custom_fields.html - added video link
  • /User_Guide/Marketing_Campaigns/senders.html - added video link
  • /User_Guide/Marketing_Campaigns/templates.html - added video link
  • /User_Guide/Marketing_Campaigns/index.html - changed video dimensions to width = “700” height = “400”
  • /User_Guide/Marketing_Campaigns/Campaigns/index.html - put info block text inline
  • /User_Guide/Marketing_Campaigns/contacts.html - added ability to skip columns when uploading CSVs, minor line edits
  • /User_Guide/Marketing_Campaigns/templates.html - linked to Drag & Drop editor

Glossary

  • Edited Automated Email related entries to include "automation" for better search results:
    • automated_email.html
    • triggered_email.html
    • triggered_actions.html
    • triggering_events.html

Moved

  • Moved Marketing_Emails_API to Web API directory
    • added necessary redirects to _redirects.htaccess
  • Moved marketing emails into a legacy directory
  • Moved all v2 API Endpoints to the Web API directory
  • Moved all deprecated and legacy features to Legacy Features Directory
    • Marketing Emails is now in User Guide > Legacy Features > Legacy Newsletter
    • Links to deprecated/legacy features updated to point to new directory

Deleted

  • Removed old/deprecated features:
    • API_Reference/Web_API/Legacy_Features/Reseller_API/V1_(deprecated)/automatic_login.html
      • Redirect pointing to removed file now points to: /API_Reference/Web_API/Legacy_Features/Reseller_API/v1_(deprecated)/index.html
    • API_Reference/Web_API/Reseller_API/Reseller_Customer_Subuser_API/customer_subuser_automatic_login.html
      • Redirect pointing to removed file now points to: /API_Reference/Web_API/Reseller_API/Reseller_Customer_Subuser_API/index.html
    • API_Reference/Web_API/Reseller_API/automatic_login.html

PRs

Assets 2
Loading

20150929 Docs Updates

29 Sep 16:49
@mbernier mbernier
20150929
2bab3f5
Compare
Choose a tag to compare
20150929 Docs Updates

Added

API

  • /API_Reference/Web_API_v3/user.html - manage your user profile
  • /API_Reference/Web_API_v3/cancel_scheduled_send.html added cancel schedule send and batch_id endpoints

Classroom

  • Classroom/Basics/email_flow.html - Explanation of email flow

User Guide

  • added Multiple credentials page back, it got deleted

Changed

All Over

  • added some new navigation for creating accounts
  • changed therubyracer version to 0.12.2
  • removed references to "apps"
  • modified how docs gets deployed via Travis to use new containers and to cache the upstream dependencies
  • forced modernizr to a specific version

API

  • There are no "apps" anymore, they are called "settings"
  • The mention of RFC 2822 is no longer applicable on mail send date formatting, because we don't require 2 digit dates.
  • Categories - aggregate by is not a date, it's a string
  • Webhook events - added notes about timestamps
  • API_Reference/Web_API/mail.html - added messages limitation
  • API_Reference/Webhooks/event.html - added params and updated to have more info, reorganized events by name
  • added /v3/user/account to the User's API page
  • removed the last_email_sent_at parameter from the ASM groups API results
  • /API_Reference/SMTP_API/scheduling_parameters.html new batch_id params for linking sends together and canceling scheduled sends
  • /API_Reference/SMTP_API/suppressions.html new asm parameters for determining which supression groups to display to customers when they unsubscribe
  • /API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html removed "last_email_sent_at" parameter from the response body

Glossary

  • Added provisioning VidGrid

Integrate

  • Exim page had an email as username, it's your SendGrid username
  • Webhook link was changed from Eventhook (Php) to Eventkit (Ruby)
  • /Integrate/Code_Examples/java.html updated to reflect library changes for the API Keys

User Guide

  • Clarification on Suppressions and blocks by @jacobmovingfwd
  • Updated the URL for multifactor authentication
  • User_Guide/Settings/Whitelabel/index.html - updated to reflect whitelabel rules I didn't explain very well
  • /User_Guide/Settings/index.html - Added links to information within the Settings section.
  • Added notes to the Whitelabel IPs page
  • /User_Guide/Suppressions/index.html fixed a bad link

Moved

Deleted

  • /User_Guide/Settings/dkim.html - Removed because these features are replaced and enhanced by our new whitelabel features
  • /User_Guide/Settings/domain_keys.html - Removed because these features are replaced and enhanced by our new whitelabel features

PRs

Assets 2
Loading

07/31/2015

31 Jul 20:23
@mbernier mbernier
20150731
64630b1
Compare
Choose a tag to compare
07/31/2015

Changed

All Over

  • The blueprint converter was carrying attributed from one endpoint to another in the API

Classroom

  • CDN page was updated for Fastly

API

  • Added new subusers endpoints - Monitor settings and disable subuser endpoint
  • @taz77 Added info to v3 overview about API Keys
  • removed excess /v3/ from subusers endpoint's URIs
  • spamreport was changed to spam_report to fit actual functionality of the endpoints, within mail settings API
  • New events image on the Webhooks event page

User Guide

  • Nearly every page had copyedits made for clarity, grammar, and punctuation (look at that Oxford comma)

Moved

  • Two-factor auth page was changed to multifactor auth

Deleted

  • Vidgrid section is gone. Each video has been merged into the page where the subject of the video is covered. There were some out of date videos that were taken out, they are being and will be placed on the correct pages.

PRs

Assets 2
Loading

New UI release docs

07 Jul 02:11
@mbernier mbernier
20150706
2dbc8d1
Compare
Choose a tag to compare
New UI release docs

Added

API

  • /API_Reference/Web_API_v3/Whitelabel/domains.html - domain whitelabel API Page
  • /API_Reference/Web_API_v3/Whitelabel/ips.html - IPs whitelabel page
  • /API_Reference/Web_API_v3/Whitelabel/links.html - links whitelabel page
  • /API_Reference/Web_API_v3/subusers.html - subusers API

User Guide

  • /User_Guide/Settings/Whitelabel/domains.html
  • /User_Guide/Settings/Whitelabel/faq.html
  • /User_Guide/Settings/Whitelabel/index.html
  • /User_Guide/Settings/Whitelabel/ips.html
  • /User_Guide/Settings/Whitelabel/links.html

Changed

All Over

  • Removed sendgrid.com/beta/ links from the pages that had it.
  • Replaced the logo in the header to match branding guidelines
  • Added tags to the config for repeated URLs, making find/replace go away for those URLs
  • Updated the functionality of the apiv3 plugin and the apiblueprint parser to show more information and get more out of the blueprints
  • Changed "credits" to "emails"
  • Customer Package names follow the new names
  • Permissions notes follow the new package setups
  • References to "Beta Interface" or "Beta Portal" have been changed to "Customer Portal"
  • Removed all "this is beta" notifications from pages

API

  • Updated URIs for Customer Subuser API endpoints for Bounce, Unsubscribe, and Spam Reports
  • Cleaned up the usage of "e-mail", because seriously WHAT!?
  • Scheduling emails can be done out to 72 hours now
  • Fixed the parameter for text/html in Filter Settings v2 Web API endpoint example
  • Added sg_message_id to event webhook examples
  • updated the settings URIs to not have redundant /v3/
  • /API_Reference/SMTP_API/apps.html replaced "app" with "settings"
  • /API_Reference/Web_API_v3/Stats/advanced.html - changed the content to explain what data we store

Glossary

  • Updated warmup page
  • /Glossary/spf.html has new SPF information

Integrate

  • Updated Go example to use a proper variable

User Guide

  • Changed links for warmup to go to the new URL
  • Videos are being moved to the User Guide pages that cover the feature covered in the video
  • Split testing information was added to Marketing Emails Create and Manage page along with videos
  • /User_Guide/Settings/two_factor_authentication.html - more in depth information added
  • /User_Guide/Suppressions/advanced_suppression_manager.html added vidgrid to this page
  • /User_Guide/Templates/index.html - new vidgrid on this page
  • /User_Guide/dashboard.html updated to reflect new UI changes made since the first draft
  • /User_Guide/email_activity.html vidgrid added and content modified to fit released funtionality

VidGrid
this section is going away as the videos get replaced. All pages will be redirected to the new User Guide page which will feature the new video Any pages removed, have been redirected.

  • /VidGrid/index.html - old URLs removed

Moved

Deleted & Redirected

  • /User_Guide/Setting_Up_Your_Server/Whitelabeling/dns_setup.html
  • /User_Guide/Setting_Up_Your_Server/Whitelabeling/index.html
  • /User_Guide/Setting_Up_Your_Server/Whitelabeling/spf.html
  • /User_Guide/Setting_Up_Your_Server/Whitelabeling/whitelabel_wizard.html
  • /VidGrid/email_activity.html
  • /VidGrid/whitelabel.html
  • /VidGrid/Event_Notification/configure.html

PRs

Assets 2
Loading

06/02/2015

02 Jun 21:41
@mbernier mbernier
20150602
c5d8fc4
Compare
Choose a tag to compare
06/02/2015

Tl;DR; Added new documentation to get towards the goal of full Customer Portal coverage, this also included redirecting many pages that don't belong.

The new Beta UI that we have is nearly ready to go, so we covered as much as we could in the User Guide. Upon doing this, the realization that the User Guide should be about customer facing UI only and that there are better places for our "How To" documentation. So, we started moving things around and redirecting them so that everyone can still find things and no one's bookmarks break.

Also, started breaking up the notes below by section, since there were so many changes on this release.

Added

API

User Guide

Modified

User Guide

API

Integrate

Glossary

Minor Changes

Moved

Old stuff:

API

  • Suppressions API - /API_Reference/SMTP_API/suppressions.md
  • Mail - /API_Reference/Web_API/mail.html fixed a description
  • v2 Unsubscribes /API_Reference/Web_API/unsubscribes.html - added delete_all=1 to the notes

User Guide

VidGrid

Deleted & redirected

Most of these pages have new homes and will redirect to those new pages now.

  • /API_Reference/Customer_Subuser_API/automatic_login.html
  • /API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.html
  • /API_Reference/Web_API_v3/event_activity.html (Dana requested)
  • /API_Reference/Web_API_v3/Unsubscribe_Manager/global_unsubscribes.html
  • /API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html
  • /API_Reference/Web_API_v3/Unsubscribe_Manager/index.html
  • /API_Reference/Web_API_v3/Unsubscribe_Manager/unsubscribes.html
  • /User_Guide/Account/Account_Settings/index.html
  • /User_Guide/Account/Account_Settings/global_settings.html
  • /User_Guide/Account/Account_Settings/profile_settings.html
  • /User_Guide/Account/alert_settings.html
  • /User_Guide/Account/billing.html
  • /User_Guide/Account/billing_history.html
  • /User_Guide/Account/billing_settings.html
  • /User_Guide/Account/index.html
  • /User_Guide/Apps/address_whitelisting.html
  • /User_Guide/Apps/bcc.html
  • /User_Guide/Apps/click_trac...
Read more
Assets 2
Loading