Add/Remove Do Not Call

This request allows you to change a customer's phone number status to "Do Not Call".

General

In certain lending circumstances, you may need to mark a customer's phone number as "Do Not Call". Here is what you need to know about "Do Not Call" phone numbers:

  • As we've mentioned on our other customer phone requests, multiple phone numbers can be associated with a single customer. We generally advise against deleting phone numbers; instead, we suggest marking them as "Do Not Call" 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 request.

For more information on this request, take a look at API - Do Not Call.

Database

For information on Phones and Customer database tables, see the following articles:

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

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the Phones object by clicking the "+" icon and hit Try It to send the request.

However, 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.

Language
Authentication
Click Try It! to start a request and see the response here!