> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dncscrub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# add_ebr Tool

> Add Existing Business Relationship records to establish DNC exemptions

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

<ParamField body="records" type="array" required>
  Array of EBR records to add.

  <Expandable title="record object">
    <ParamField body="phoneNumber" type="string" required>
      10-digit phone number.
    </ParamField>

    <ParamField body="dateOfLastContact" type="string" required>
      Date of the business relationship event. Formats: `MM/DD/YY`, `MM/DD/YYYY`, or `YYYY-MM-DD`.
    </ParamField>

    <ParamField body="type" type="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)
    </ParamField>

    <ParamField body="brand" type="string">
      Company/product/brand name used to establish the EBR.
    </ParamField>

    <ParamField body="referenceNum" type="string">
      Your internal tracking ID for audit purposes.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="loginId" type="string">
  API key. Only required if not provided via the `x-dncscrub-api-key` HTTP header.
</ParamField>

<ParamField body="keepBetterEBR" type="boolean">
  If `true`, existing EBR records with longer exemption periods won't be overwritten.
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Whether the API call succeeded.
</ResponseField>

<ResponseField name="recordsAdded" type="number">
  Number of EBR records successfully added.
</ResponseField>

<ResponseField name="errorCode" type="string">
  Machine-readable error code (when failed).
</ResponseField>

<ResponseField name="errorMessage" type="string">
  Human-readable error description (when failed).
</ResponseField>

## EBR Expiration Rules

| EBR Type            | Federal Exemption Period        |
| ------------------- | ------------------------------- |
| Sale/Purchase (`S`) | 18 months from last transaction |
| Inquiry (`I`)       | 3 months from inquiry date      |

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

## Examples

<Tabs>
  <Tab title="Single EBR">
    ```json theme={null}
    {
      "records": [
        {
          "phoneNumber": "7075712071",
          "dateOfLastContact": "2024-06-14",
          "type": "S",
          "brand": "Acme Corp"
        }
      ]
    }
    ```
  </Tab>

  <Tab title="Multiple EBRs">
    ```json theme={null}
    {
      "records": [
        {
          "phoneNumber": "7075712071",
          "dateOfLastContact": "2024-06-14",
          "type": "S"
        },
        {
          "phoneNumber": "7072842774",
          "dateOfLastContact": "2024-07-02",
          "type": "I",
          "referenceNum": "LEAD-12345"
        }
      ]
    }
    ```
  </Tab>

  <Tab title="Success Response">
    ```json theme={null}
    {
      "success": true,
      "recordsAdded": 2
    }
    ```
  </Tab>
</Tabs>

## 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