Edit Do Not Call Status

General

Certain lending circumstances require lenders to mark a customer's phone number as "Do Not Call". Here is what you need to know about this request:

• Multiple phone numbers can be associated with a single customer. Some lenders will mark a phone number as "Do Not Call" instead of deleting it in the instance that the number needs to used in the future.
• Marking a phone number as "Do Not Call" does not delete the phone number. Instead, the full number is hidden from view and removed from any automated phone services.
• To receive a 200 response from this request, you will need both the ID of the customer and the ID of their phone number. To find the ID of a phone number, you can use a GET Phones request.

For an example of how customer phones work within the UI, take a look at our Customer Phones article.

Database

For information regarding customer and phone database tables, see the following articles:

• Database – Customer Phone Entity (customer_phone_entity)
• Database – Customer Main Table (customer_entity)

{
    "Phones": {
        "results": [
            {
                "dndEnabled": 1,
                "__update": true,
                "__id": 196
            }
        ]
    }
}

📘

Try It Instructions

Our pages often provide sample payload information so that you can try requests yourself. This request is ready for you—expand the object by clicking the "+" symbol and hit the Try It button to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.