You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/use-cases/data-residency-set-hostname.md
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Choosing a hostname to send messages to
1
+
# Choosing a data-residency to send messages to
2
2
3
3
Use the `setDataResidency` setter to specify which host to send to:
4
4
5
-
Send to EU (hostname: `https://api.eu.sendgrid.com/`)
5
+
Send to EU (data-residency: `https://api.eu.sendgrid.com/`)
6
6
```js
7
7
constsgMail=require('@sendgrid/mail');
8
8
sgMail.setDataResidency('eu');
@@ -16,7 +16,7 @@ const msg = {
16
16
sgMail.send(msg);
17
17
```
18
18
Send to Global region, this is also the default host, if the setter is not used
19
-
(hostname: `https://api.sendgrid.com/`)
19
+
(data-residency: `https://api.sendgrid.com/`)
20
20
```js
21
21
constsgMail=require('@sendgrid/mail');
22
22
sgMail.setDataResidency('global');
@@ -32,7 +32,6 @@ sgMail.send(msg);
32
32
33
33
## Limitations
34
34
35
-
1. Setting the API Key (via `client.setApiKey()`) or Twilio Authentication (via `client.setTwilioEmailAuth()`) will override the hostname to default value. Use the setter call after this set-up.
36
-
2. Emails can only be sent to two hosts for now; 'eu' (https://api.eu.sendgrid.com/) and 'global' (https://api.eu.sendgrid.com/)
37
-
2. The default hostname is https://api.sendgrid.com/
35
+
1. Emails can only be sent to two hosts for now; 'eu' (https://api.eu.sendgrid.com/) and 'global' (https://api.eu.sendgrid.com/)
36
+
2. The default data-residency is https://api.sendgrid.com/
38
37
3. The valid values for `region` in `client.setDataResidency(region)` are only `eu` and `global`. Case-sensitive.
0 commit comments