add_ebr Tool - Contact Center Compliance

The 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

required

Array of EBR records to add.

Show record object

string

required

10-digit phone number.

string

required

Date of the business relationship event. Formats: MM/DD/YY, MM/DD/YYYY, or YYYY-MM-DD.

string

required

EBR type:

S - Sale/Purchase (18-month exemption)
I - Inquiry (3-month exemption)
P - Permission (express written consent / opt-in; the only type that can override an Internal DNC entry)

string

Company/product/brand name used to establish the EBR.

string

Your internal tracking ID for audit purposes.

API key. Only required if not provided via the x-dncscrub-api-key HTTP header.

boolean

If true, existing EBR records with longer exemption periods won’t be overwritten.

Response

boolean

Whether the API call succeeded.

number

Number of EBR records successfully added.

string

Machine-readable error code (when failed).

string

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

State rules may have shorter exemption periods. The scrub API accounts for state-specific rules automatically.

Examples

Single EBR
Multiple EBRs
Success Response

{
  "records": [
    {
      "phoneNumber": "7075712071",
      "dateOfLastContact": "2024-06-14",
      "type": "S",
      "brand": "Acme Corp"
    }
  ]
}

{
  "records": [
    {
      "phoneNumber": "7075712071",
      "dateOfLastContact": "2024-06-14",
      "type": "S"
    },
    {
      "phoneNumber": "7072842774",
      "dateOfLastContact": "2024-07-02",
      "type": "I",
      "referenceNum": "LEAD-12345"
    }
  ]
}

{
  "success": true,
  "recordsAdded": 2
}

Usage Notes

Use accurate dates—the dateOfLastContact should be the actual business relationship date, not today’s date
Choose the correct EBR type: using the wrong type could create compliance issues
The referenceNum field is useful for audit trails and tracing back to your CRM records
Set keepBetterEBR: true to prevent accidentally downgrading a Sale EBR to an Inquiry EBR

​Parameters

​Response

​EBR Expiration Rules

​Examples

​Usage Notes

Parameters

Response

EBR Expiration Rules

Examples

Usage Notes