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

Commit e8ef4a1

Browse files
author
Matt Bernier
committed
Merge pull request #983 from sendgrid/content_89
Content 89
2 parents b1a4ae0 + 0331f06 commit e8ef4a1

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

source/API_Reference/Web_API/filter_settings.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ When using this call, you must define all emails & domains here. Using this call
2626
{% parameters addresswhitelist %}
2727

2828
{% parameter name yes 'addresswhitelist' 'The name of the app for which to apply settings.' %}
29-
{% parameter list no 'A list of email addresses or domains.' 'list[]=[email protected]&list[]=[email protected]' %}
29+
{% parameter list yes 'A list of email addresses or domains.' 'list[]=[email protected]&list[]=[email protected]' %}
3030
{% endparameters %}
3131

3232
{% apiexample addresswhitelist POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=addresswhitelist&list[]=[email protected]&list[]=[email protected] %}
@@ -243,6 +243,7 @@ Footer
243243

244244
*API App Name - `footer`*
245245

246+
You must provide either text/html or text/plain, or both, to avoid receiving a "missing parameters" error.
246247

247248
{% parameters footer %}
248249
{% parameter 'name' 'Yes' 'footer' 'The app for which to set or retrieve settings.' %}
@@ -273,6 +274,7 @@ Google Analytics
273274

274275
*API App Name - `ganalytics`*
275276

277+
At least one of the optional parameters needs to be passed to avoid a "missing parameters" error.
276278

277279
{% parameters ganalytics %}
278280
{% parameter 'name' 'Yes' 'ganalytics' 'The app for which to set or retrieve settings.' %}
@@ -300,22 +302,6 @@ Google Analytics
300302

301303
* * * * *
302304

303-
{% anchor h2 %}
304-
Gravatar
305-
{% endanchor %}
306-
307-
*API App Name - `gravatar`*
308-
309-
* * * * *
310-
311-
{% anchor h2 %}
312-
Open Tracking
313-
{% endanchor %}
314-
315-
*API App Name - `opentrack`*
316-
317-
* * * * *
318-
319305
{% anchor h2 %}
320306
SPAM Filter Checker
321307
{% endanchor %}
@@ -325,12 +311,12 @@ SPAM Filter Checker
325311

326312
{% parameters spamcheck %}
327313
{% parameter 'name' 'Yes' 'spamcheck' 'The app for which to set or retrieve settings.' %}
328-
{% parameter 'maxscore' 'Yes' 'Emails with a spam score over this value will be considered spam and will not be delivered to the recipient. The default spam threshold is 5.0, but you can set this to any value you wish. We use SpamAssassin to process the spam checks for this filter, so you can base your maxscore setting on values typically used with SpamAssassin' '1.2' %}
314+
{% parameter 'max_score' 'Yes' 'Emails with a spam score over this value will be considered spam and will not be delivered to the recipient. The default spam threshold is 5.0, but you can set this to any value you wish. We use SpamAssassin to process the spam checks for this filter, so you can base your maxscore setting on values typically used with SpamAssassin' '1.2' %}
329315
{% parameter 'url' 'Yes' 'URL to post the email and a copy of the detailed SpamAssassin report describing why the email was designated as spam' 'https://www.example.com/spamcheck.php' %}
330316
{% endparameters %}
331317

332318

333-
{% apiexample spamcheck POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=eventnotify&maxscore=1.2&url=https://www.example.com/spamcheck.php %}
319+
{% apiexample spamcheck POST https://api.sendgrid.com/api/filter.setup api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=eventnotify&max_score=1.2&url=https://www.example.com/spamcheck.php %}
334320
{% response json %}
335321
{
336322
"message": "success"
@@ -352,6 +338,7 @@ Subscription Tracking
352338

353339
*API App Name - `subscriptiontrack`*
354340

341+
You must pass at least one of the optional params in order to avoid the "missing parameter" error.
355342

356343
{% parameters subscriptiontrack %}
357344
{% parameter 'name' 'Yes' 'subscriptiontrack' 'The app for which to set or retrieve settings.' %}
@@ -388,8 +375,8 @@ SendGrid for New Relic
388375

389376
{% parameters newrelic %}
390377
{% parameter 'name' 'Yes' 'newrelic' 'The app for which to set or retrieve settings.' %}
391-
{% parameter 'license_key' 'YES' 'Can be found in New Relic Settings page' %}
392-
{% parameter 'enable_subusers' 'YES' 'false to disable, true to enable' %}
378+
{% parameter 'license_key' 'Yes' 'Can be found in New Relic Settings page' %}
379+
{% parameter 'enable_subusers' 'Yes' 'false to disable, true to enable' %}
393380
{% endparameters %}
394381

395382

@@ -416,7 +403,7 @@ Sendwithus
416403

417404
{% parameters sendwithus %}
418405
{% parameter 'name' 'Yes' 'sendwithus' 'The app for which to set or retrieve settings.' %}
419-
{% parameter 'license_key' 'YES' 'Can be found in Sendwithus Settings page' %}
406+
{% parameter 'license_key' 'Yes' 'Can be found in Sendwithus Settings page' %}
420407
{% endparameters %}
421408

422409

0 commit comments

Comments
 (0)