API: Request Flags
The behavior of the FreshAddress SafeToSend API can be modified by including flags in each API request URL. Once your account has been migrated to the InstantData portal, you may see some changes depending on which flags you are using.
Note that regardless of whether you're using these flags, the overall impact on API responses is marginal. The email addresses that fall under the purview of these flags are edge cases, and the impact is typically under 1% of your total traffic.
List of Flags
Request flags for the FreshAddress API include the following:
URL Parameter | Applicable Comment | Definition | Accepted Values |
---|---|---|---|
emps | EMPS suppression | The email address appears on the DMA's "Do Not Email List" (Electronic Mail Preference Service). | true / false |
role | role account | The email address has a non-personal handle. | true / false |
bogus | bogus | The email address is fictitious, e.g. [email protected] | true / false |
language | language | The email address handle contains derogatory words. | true / false |
fccwireless | FCC wireless | The email address is associated with a domain that has restrictions on commercial email per the FCC. | true / false |
disposable | disposable | The email address originates from a website that provides temporary email addresses OR appears to be temporary. | true / false |
complain | frequent complainer | The email address owner is known to submit spam complaints. | true / false |
Post-Migration Changes
Once your account has been migrated to the InstantData portal, the most significant change is that the "emps" and "complain" flags will be centrally configurable at an account level but, if specified in a request URL, will not impact the response.
The "language" flag has been absorbed by the "bogus" flag. Addresses with profane usernames will return the same "bogus" response as addresses with bogus usernames such as "[email protected]". Setting either "language" or "bogus" to false will disable the "bogus" response.
Setting any of the flags to false will no longer result in a "customer override" response for qualifying addresses. Typically the response will be "valid".
URL parameter | Behavior |
---|---|
emps | Available in URL: No (allowed, but will not impact response) Available in account configuration: Yes -- Please contact us if you wish to disable this option. Behavior: No change when this is configured for your account. Slight change when not configured. If true or not present, and address is an EMPS address, no change: "FINDING" : "W", "COMMENT" : "EMPS Suppression", "COMMENT_CODE" : "XE", If false, the address will be fully validated, and we will not return "customer override": |
role | Available in URL: Yes Behavior: No change when not present in URL or set to true. Slight change when set to false in the URL. If true or not present, and address is an role address, same as pre-migration: "FINDING" : "W", "COMMENT" : "Role account", "COMMENT_CODE" : "XR", If false, we return a standard response rather than "customer override": "FINDING" : "V", "COMMENT" : "Valid", "COMMENT_CODE" : "V", |
bogus | Available in URL: Yes Behavior: No change when not present in URL or set to true. Slight change when set to false in the URL. If true or not specified in the URL, bogus addresses will be flagged: "FINDING" : "W", "COMMENT" : "Bogus", "COMMENT_CODE" : "XB", If false, we return a standard response rather than "customer override": "FINDING" : "V", "COMMENT" : "Valid", "COMMENT_CODE" : "V", This is a synonym for &language, and if either flag is set to false, then the false setting will apply to both flags, even if one of them is set to true. |
language | Available in URL: Yes This is a now a synonym for "bogus", and if either flag is set to false, then the false setting will apply to both flags, even if one of them is set to true. If both "bogus" and "language" are set to true or not specified in the URL: "FINDING" : "W", "COMMENT" : "bogus", "COMMENT_CODE" : "XB", If either "bogus" or "language" is set to false, we return a standard response rather than "customer override": "FINDING" : "V", "COMMENT" : "valid", "COMMENT_CODE" : "V", |
fccwireless | Available in URL: Yes Behavior: No change when not present in URL or set to true. Slight change when set to false in the URL. If true or not specified in the URL, addresses with wireless domains will be flagged: "FINDING" : "W", "COMMENT" : "FCC wireless", "COMMENT_CODE" : "XW", If false, we return a standard response rather than "customer override": "FINDING" : "V", "COMMENT" : "valid", "COMMENT_CODE" : "V", |
disposable | Available in URL: Yes Behavior: No change when not present in URL or set to true. Slight change when set to false in the URL. If true or not specified in the URL, addresses with disposable domains will be flagged:: "FINDING" : "W", "COMMENT" : "Disposable", "COMMENT_CODE" : "XD", If false, we return a standard response rather than "customer override": "FINDING" : "V", "COMMENT" : "valid", "COMMENT_CODE" : "V", |
complain | Available in URL: No (allowed, but will not impact response) Available in account configuration: Yes -- Please contact us if you wish to disable this option. Behavior: No change when this is configured for your account. Slight change when not configured. If true or not present, and address is a frequent complainer, no change: "FINDING" : "W", "COMMENT" : "problematic", "COMMENT_CODE" : "XP", If false, the address will be fully validated, and we will not return "customer override": |
Updated 4 days ago