add_ebr tool adds Existing Business Relationship records to your DNCScrub account. An EBR can provide an exemption to DNC rules, allowing you to contact numbers that would otherwise be restricted.
Parameters
Array of EBR records to add.
API key. Only required if not provided via the
x-dncscrub-api-key HTTP header.If
true, existing EBR records with longer exemption periods won’t be overwritten.Response
Whether the API call succeeded.
Number of EBR records successfully added.
Machine-readable error code (when failed).
Human-readable error description (when failed).
EBR Expiration Rules
| EBR Type | Federal Exemption Period |
|---|---|
Sale/Purchase (S) | 18 months from last transaction |
Inquiry (I) | 3 months from inquiry date |
Examples
- Single EBR
- Multiple EBRs
- Success Response
Usage Notes
- Use accurate dates—the
dateOfLastContactshould be the actual business relationship date, not today’s date - Choose the correct EBR type: using the wrong type could create compliance issues
- The
referenceNumfield is useful for audit trails and tracing back to your CRM records - Set
keepBetterEBR: trueto prevent accidentally downgrading a Sale EBR to an Inquiry EBR