Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update USAGE.md to prevent query double encoding #878

Merged
merged 1 commit into from
Feb 13, 2020
Merged

docs: Update USAGE.md to prevent query double encoding #878

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/client/USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3102,6 +3102,8 @@ Filter by subject line - `query=subject%3d%22A%20Great%20Subject%22`

You can filter by other operators besides `=`. We also accept `!=`, `<`, and `>`.

If you use the `@sendgrid/client` library, you do not have to encode anything (it will end up being double encoded).

For a tutorial on how to get started, check out [Getting Started with the Email Activity API](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html).

**Full list of basic query types and examples:**
Expand Down Expand Up @@ -3228,7 +3230,7 @@ For information about building combined queries, see [Building compound Email Ac
```javascript
const queryParams = {
'limit': 10,
'query': 'from_email%3D%22testing%40sendgrid.net%22'
'query': 'from_email="testing@sendgrid.net"'
};
request.qs = queryParams;
request.method = 'GET';
Expand Down