This package is part of a monorepo, please see this README for details.
Client for the Sendgrid v3 Web API
This client library is used by the other SendGrid service packages to make requests to the Sendgrid v3 Web API. You can also use it independently to make custom requests to the SendGrid v3 Web API and other HTTP APIs.
To be notified when this package is updated, please subscribe to email notifications for releases and breaking changes.
- Node.js version 6, 7 or 8
- A SendGrid account, sign up for free to send up to 40,000 emails for the first 30 days or check out our pricing.
Obtain an API Key
Grab your API Key from the SendGrid UI.
Setup Environment Variables
Do not hard code your SendGrid API Key into your code. Instead, use an environment variable or some other secure means of protecting your SendGrid API Key. Following is an example of using an environment variable.
Update the development environment with your SENDGRID_API_KEY, for example:
echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.envecho "sendgrid.env" >> .gitignoresource ./sendgrid.env
npm install --save @sendgrid/client
You may also use yarn to install.
yarn add @sendgrid/client
General v3 Web API Usage Example
const client = ;client;const request =method: 'GET'url: '/v3/api_keys';client
Add a Custom Default Header
Change Request Defaults
Overwrite Promise Implementation
You can overwrite the promise implementation you want the client to use. Defaults to the ES6
globalPromise = ;
Instantiate Client Instances Manually
const Client = ;const sgClient1 = ;const sgClient2 = ;sgClient1;sgClient2;
How to Contribute
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Please see our troubleshooting guide for common library issues.
@sendgrid/client is guided and supported by the SendGrid Developer Experience Team.
@sendgrid/client is maintained and funded by SendGrid, Inc. The names and logos for @sendgrid/client are trademarks of SendGrid, Inc.