This package is part of a monorepo, please see this README for details.
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.
Grab your API Key from the SendGrid UI.
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
const client = ;client;const request =method: 'GET'url: '/v3/api_keys';client
You can overwrite the promise implementation you want the client to use. Defaults to the ES6
globalPromise = ;
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.